Adding docs to describe message contents
This commit is contained in:
parent
a27569770b
commit
0fc2352c07
|
@ -21,6 +21,14 @@ import com.squareup.moshi.JsonClass
|
||||||
import org.matrix.android.sdk.api.session.events.model.Content
|
import org.matrix.android.sdk.api.session.events.model.Content
|
||||||
import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
|
import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Content of the state event of type
|
||||||
|
* [EventType.STATE_ROOM_BEACON_INFO][org.matrix.android.sdk.api.session.events.model.EventType.STATE_ROOM_BEACON_INFO]
|
||||||
|
*
|
||||||
|
* It contains general info related to a live location share.
|
||||||
|
* Locations are sent in a different message related to the state event.
|
||||||
|
* See [MessageBeaconLocationDataContent][org.matrix.android.sdk.api.session.room.model.message.MessageBeaconLocationDataContent]
|
||||||
|
*/
|
||||||
@JsonClass(generateAdapter = true)
|
@JsonClass(generateAdapter = true)
|
||||||
data class MessageBeaconInfoContent(
|
data class MessageBeaconInfoContent(
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -21,6 +21,14 @@ import com.squareup.moshi.JsonClass
|
||||||
import org.matrix.android.sdk.api.session.events.model.Content
|
import org.matrix.android.sdk.api.session.events.model.Content
|
||||||
import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
|
import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Content of the state event of type
|
||||||
|
* [EventType.BEACON_LOCATION_DATA][org.matrix.android.sdk.api.session.events.model.EventType.BEACON_LOCATION_DATA]
|
||||||
|
*
|
||||||
|
* It contains location data related to a live location share.
|
||||||
|
* It is related to the state event that originally started the live.
|
||||||
|
* See [MessageBeaconInfoContent][org.matrix.android.sdk.api.session.room.model.message.MessageBeaconInfoContent]
|
||||||
|
*/
|
||||||
@JsonClass(generateAdapter = true)
|
@JsonClass(generateAdapter = true)
|
||||||
data class MessageBeaconLocationDataContent(
|
data class MessageBeaconLocationDataContent(
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Reference in New Issue