Space - daneden/Twift GitHub Wiki

Space

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.

public struct Space: Codable, Identifiable 

Inheritance

Codable, Expandable, Fielded, Identifiable

Nested Type Aliases

ID

public typealias ID = String

Field

public typealias Field = PartialKeyPath<Self>

Properties

id

The unique identifier of the requested Space.

public let id: ID

state

Indicates if the Space has started or will start in the future, or if it has ended.

public let state: String

createdAt

Creation time of this Space.

public let createdAt: Date?

endedAt

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

public let endedAt: Date?

hostIds

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

public let hostIds: [User.ID]?

lang

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

public let lang: String?

isTicketed

Indicates is this is a ticketed Space.

public let isTicketed: Bool?

invitedUserIds

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.

public let invitedUserIds: [User.ID]?

participantCount

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

public let participantCount: Int?

scheduledStart

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.

public let scheduledStart: Date?

speakerIds

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

public let speakerIds: [User.ID]?

startedAt

Indicates the actual start time of a Space.

public let startedAt: Date?

title

The title of the Space as specified by the creator.

public let title: String?

topicIds

A list of IDs of the topics selected by the creator of the Space.

public let topicIds: [Topic.ID]?

updatedAt

Specifies the date and time of the last update to any of the Space's metadata, such as its title or scheduled time.

public let updatedAt: Date?
⚠️ **GitHub.com Fallback** ⚠️