Participant

public class Participant : Codable, LiveUser

A class that provides general information about a participant in a live event.

Since

1.0.0

  • The unique ID of the participant. Participant ID is generated each time the user enters a live event.

    Since

    1.0.0

    Declaration

    Swift

    public let participantId: String

  • The unique ID of the user.

    Since

    1.0.0

    Declaration

    Swift

    public let userId: String

  • The nickname of the user.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var nickname: String? { get }

  • The profile image of the user.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var profileURL: String? { get }

  • Timestamp when the participant entered the live event.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var enteredAt: Int64 { get }

  • Timestamp when the participant exited the live event.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var exitedAt: Int64? { get }

  • The period from the time when the participant entered the live event to the time the participant exited the live event.

    Since

    1.0.0

    Declaration

    Swift

    public var duration: Int64 { get }

  • The state of the participant. Valid values are entered and exited.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var state: Participant.State { get }

  • The unique ID of the live event.

    Since

    1.0.0

    Declaration

    Swift

    public let liveEventId: String

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • An enum that provides information about the states of a participant.

    Since

    1.0.0
    See more

    Declaration

    Swift

    public enum State : String, Codable