RoomPinned (common-api 0.9.0 API)

java.lang.Object
- io.github.ma1uta.matrix.event.Event<C>
- - io.github.ma1uta.matrix.event.RoomEvent<C>
  - - io.github.ma1uta.matrix.event.StateEvent<RoomPinnedContent>
    - - io.github.ma1uta.matrix.event.RoomPinned

```
public class RoomPinned
extends StateEvent<RoomPinnedContent>
```
This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String TYPE
  This event is used to "pin" particular events in a room for other participants to review later.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  RoomPinned()
- Method Summary
  
  Modifier and Type Method Description
  
  String getType()
  Required.
  - Methods inherited from class io.github.ma1uta.matrix.event.StateEvent
    getPrevContent, getStateKey, setPrevContent, setStateKey
  - Methods inherited from class io.github.ma1uta.matrix.event.RoomEvent
    getEventId, getOriginServerTs, getRoomId, getSender, getUnsigned, setEventId, setOriginServerTs, setRoomId, setSender, setUnsigned
  - Methods inherited from class io.github.ma1uta.matrix.event.Event
    getContent, setContent
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final String TYPE
```
    This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RoomPinned
```
public RoomPinned()
```
- Method Detail
  - getType
```
public String getType()
```
    Description copied from class: Event
    
    Required. The type of event. This SHOULD be namespaced similar to Java package naming conventions e.g. 'com.example.subdomain.event.type'.
    
    Specified by:
    
    getType in class Event<RoomPinnedContent>
    
    Returns:
    
    The type of the event.