RoomCanonicalAlias (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<RoomCanonicalAliasContent>
    - - io.github.ma1uta.matrix.event.RoomCanonicalAlias

```
public class RoomCanonicalAlias
extends StateEvent<RoomCanonicalAliasContent>
```
This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.
A room with an m.room.canonical_alias event with an absent, null, or empty alias field should be treated the same as a room with no m.room.canonical_alias event.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String TYPE
  This event is used to inform the room about which alias should be considered the canonical one.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  RoomCanonicalAlias()
- 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 inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RoomCanonicalAlias
```
public RoomCanonicalAlias()
```
- 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<RoomCanonicalAliasContent>
    
    Returns:
    
    The type of the event.