SpaceData class

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 found and expanded in the user resource. These objects are available for expansion by adding at least one of hostIds, creatorId, speakerIds 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.

Annotations
  • @freezed

Constructors

SpaceData({required String id, String? title, SpaceState? state, String? creatorId, SpaceLanguage? lang, List<String>? hostIds, List<String>? topicIds, List<String>? speakerIds, List<String>? invitedUserIds, int? subscriberCount, int? participantCount, bool? isTicketed, DateTime? scheduledStart, DateTime? startedAt, DateTime? endedAt, DateTime? createdAt, DateTime? updatedAt})
const
factory
SpaceData.fromJson(Map<String, Object?> json)
factory

Properties

copyWith → $SpaceDataCopyWith<SpaceData>
no setterinherited
createdAt DateTime?
Creation time of this Space.
no setterinherited
creatorId String?
The id of the Space creator.
no setterinherited
endedAt DateTime?
Time when the Space was ended. Only available for ended Spaces.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hostIds List<String>?
The unique identifier of the users who are hosting this Space.
no setterinherited
id String
The unique identifier of the requested Space.
no setterinherited
invitedUserIds List<String>?
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.
no setterinherited
isTicketed bool?
Indicates is this is a ticketed Space.
no setterinherited
lang SpaceLanguage?
Language of the Space, if detected by Twitter. Returned as a BCP47 language tag.
no setterinherited
participantCount int?
The current number of users in the Space, including Hosts and Speakers.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scheduledStart DateTime?
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.
no setterinherited
speakerIds List<String>?
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.
no setterinherited
startedAt DateTime?
Indicates the actual start time of a Space.
no setterinherited
state SpaceState?
Indicates if the Space has started or will start in the future, or if it has ended.
no setterinherited
subscriberCount int?
The number of people who set a reminder to a Space.
no setterinherited
title String?
The title of the Space as specified by the creator.
no setterinherited
topicIds List<String>?
A list of IDs of the topics selected by the creator of the Space.
no setterinherited
updatedAt DateTime?
Specifies the date and time of the last update to any of the Space's metadata, such as its title or scheduled time.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited