Interface ISpace

The details of a single Space.

interface ISpace {
    conversationControls?: number;
    createdAt?: string;
    creatorId?: string;
    disallowJoin?: boolean;
    endedAt?: string;
    id: string;
    isEmployeeOnly?: boolean;
    isLocked?: boolean;
    isMuted?: boolean;
    isSpaceAvailableForClipping?: boolean;
    isSpaceAvailableForReplay?: boolean;
    isSubscribed?: boolean;
    mediaKey?: string;
    noIncognito?: boolean;
    participantCount?: number;
    participants?: ISpaceParticipants;
    scheduledStart?: string;
    startedAt?: string;
    state?: string;
    title?: string;
    totalLiveListeners?: number;
    totalReplayWatched?: number;
    updatedAt?: string;
}

Implemented by

Properties

conversationControls? createdAt? creatorId? disallowJoin? endedAt? id isEmployeeOnly? isLocked? isMuted? isSpaceAvailableForClipping? isSpaceAvailableForReplay? isSubscribed? mediaKey? noIncognito? participantCount? participants? scheduledStart? startedAt? state? title? totalLiveListeners? totalReplayWatched? updatedAt?

Properties

OptionalconversationControls

conversationControls?: number

The conversation controls value for the space.

OptionalcreatedAt

createdAt?: string

The creation date of the space.

OptionalcreatorId

creatorId?: string

The id of the user who created the space.

OptionaldisallowJoin

disallowJoin?: boolean

Whether joining the space is disallowed.

OptionalendedAt

endedAt?: string

The end time of the space.

id

id: string

The rest id of the space.

OptionalisEmployeeOnly

isEmployeeOnly?: boolean

Whether the space is for employees only.

OptionalisLocked

isLocked?: boolean

Whether the space is locked.

OptionalisMuted

isMuted?: boolean

Whether the space is muted.

OptionalisSpaceAvailableForClipping

isSpaceAvailableForClipping?: boolean

Whether clipping is available for the space.

OptionalisSpaceAvailableForReplay

isSpaceAvailableForReplay?: boolean

Whether replay is available for the space.

OptionalisSubscribed

isSubscribed?: boolean

Whether the authenticated user is subscribed to the space.

OptionalmediaKey

mediaKey?: string

The media key of the space.

OptionalnoIncognito

noIncognito?: boolean

Whether incognito is disabled for the space.

OptionalparticipantCount

participantCount?: number

The total participant count reported in the response.

Optionalparticipants

participants?: ISpaceParticipants

The participants information for the space.

OptionalscheduledStart

scheduledStart?: string

The scheduled start time of the space.

OptionalstartedAt

startedAt?: string

The actual start time of the space.

Optionalstate

state?: string

The current state of the space.

Optionaltitle

title?: string

The title of the space.

OptionaltotalLiveListeners

totalLiveListeners?: number

The total live listeners count for the space.

OptionaltotalReplayWatched

totalReplayWatched?: number

The total replay watched count for the space.

OptionalupdatedAt

updatedAt?: string

The time at which the space was last updated.

Settings

Member Visibility

On This Page

Properties