matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.thirdparty/ThirdPartyProtocol

ThirdPartyProtocol

@JsonClass(generateAdapter = true)

data class ThirdPartyProtocol( @Json(name = "user_fields") val userFields: List<String>? = null, @Json(name = "location_fields") val locationFields: List<String>? = null, @Json(name = "icon") val icon: String? = null, @Json(name = "field_types") val fieldTypes: Map<String, FieldType>? = null, @Json(name = "instances") val instances: List<ThirdPartyProtocolInstance>? = null)

Constructors

ThirdPartyProtocol

fun ThirdPartyProtocol( @Json(name = "user_fields") userFields: List<String>? = null, @Json(name = "location_fields") locationFields: List<String>? = null, @Json(name = "icon") icon: String? = null, @Json(name = "field_types") fieldTypes: Map<String, FieldType>? = null, @Json(name = "instances") instances: List<ThirdPartyProtocolInstance>? = null)

Properties

fieldTypes

val fieldTypes: Map<String, FieldType>? = null

Required. The type definitions for the fields defined in the user_fields and location_fields. Each entry in those arrays MUST have an entry here. The string key for this object is field name itself.

icon

val icon: String? = null

Required. A content URI representing an icon for the third party protocol.

instances

val instances: List<ThirdPartyProtocolInstance>? = null

Required. A list of objects representing independent instances of configuration. For example, multiple networks on IRC if multiple are provided by the same application service.

locationFields

val locationFields: List<String>? = null

Required. Fields which may be used to identify a third party location. These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the name of a channel.

userFields

val userFields: List<String>? = null

Required. Fields which may be used to identify a third party user. These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the nickname of a user.