Twitter Api Kit/com.mcdev.twitterapikit.object/Space

Space

data class Space(id: String?, state: String?)

Spaces allow expression and interaction via live audio conversations. The Space data dictionary contains relevant metadata about a Space; all the details are updated in real time. User objects can be found and expanded in the user resource. These objects are available for expansion by adding at least one of host_ids, creator_id, speaker_ids, mentioned_user_ids to the expansions query parameter.

Unlike Tweets, Spaces are ephemeral and become unavailable after they end or when they are canceled by their creator. When your app handles Spaces data, you are responsible for returning the most up-to-date information, and must remove data that is no longer available from the platform. The Spaces lookup endpoints can help you ensure you respect the users’ expectations and intent.

Constructors

Space

fun Space(id: String? = null, state: String? = null)

Properties

createdAt

@SerializedName(value = "created_at")

var createdAt: String? = null

Creation time of this Space.

creatorId

@SerializedName(value = "creator_id")

var creatorId: String? = null

The user ID of the account that created this Space. This ID is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. To return this field, addspace.fields=creator_idin the request's query parameter. You can obtain the expanded object in includes.users by adding expansions=creator_id in the request's query parameter.

endedAt

@SerializedName(value = "ended_at")

var endedAt: String? = null

Time when the Space was ended. Only available for ended Spaces.

hostIds

@SerializedName(value = "host_ids")

var hostIds: ArrayList<String>? = null

The unique identifier of the users who are hosting this Space.

@SerializedName(value = "id")

var id: String? = null

The unique identifier of the requested Space.

invitedUserIds

@SerializedName(value = "invited_user_ids")

var invitedUserIds: ArrayList<String>? = null

The list of user IDs that were invited to join as speakers. Usually, users in this list are invited to speak via the Invite user option.

isTicketed

@SerializedName(value = "is_ticketed")

var isTicketed: Boolean = false

Indicates is this is a ticketed Space.

lang

@SerializedName(value = "lang")

var lang: String? = null

Language of the Space, if detected by Twitter. Returned as a BCP47 language tag.

participantCount

@SerializedName(value = "participant_count")

var participantCount: Int = 0

The current number of users in the Space, including Hosts and Speakers.

scheduledStart

@SerializedName(value = "scheduled_start")

var scheduledStart: String? = null

Indicates the start time of a scheduled Space, as set by the creator of the Space. This field is returned only if the Space has been scheduled; in other words, if the field is returned, it means the Space is a scheduled Space.

speakerIds

@SerializedName(value = "speaker_ids")

var speakerIds: ArrayList<String>? = null

The list of users who were speaking at any point during the Space. This list contains all the users in invited_user_ids in addition to any user who requested to speak and was allowed via the Add speaker option.

startedAt