Structures

The following structures are available globally.

  • A token that contains an authentication signature that can be used when users subscribe to a private or presence Channel.

    The token will contain any userData that was provided during the signing request. In the case of encrypted channels, it will also contain a base-64 encoded sharedSecret.

    See more

    Declaration

    Swift

    public struct AuthenticationToken : Codable
  • A channel that can be queried for information, or be published to using an Event.

    See more

    Declaration

    Swift

    public struct Channel : ChannelDescription
  • Attributes of an occupied Channel that can be fetched from the Pusher HTTP API.

    The attributes that can be fetched for a channel are dependent on its ChannelType. Attempting to fetch an attribute for a channel that does not support that attribute query will result in an error.

    See more

    Declaration

    Swift

    public struct ChannelAttributeFetchOptions : OptionSet
    extension ChannelAttributeFetchOptions: CustomStringConvertible
  • Channel attributes that can be fetched depending on the ChannelAttributeFetchOptions provided to a top-level API method (see: Pusher).

    See more

    Declaration

    Swift

    public struct ChannelAttributes : SubscriptionCountable, UserCountable, Decodable
  • An information record for an occupied Channel.

    The channel attributes are populated depending on the ChannelAttributeFetchOptions provided to a top-level API method (see: Pusher).

    See more

    Declaration

    Swift

    public struct ChannelInfo : ChannelInfoRecord, Decodable
  • A summarised information record for an occupied Channel.

    See more

    Declaration

    Swift

    public struct ChannelSummary : ChannelSummaryRecord
  • An event to trigger on a specific Channel (or multiple channels).

    See more

    Declaration

    Swift

    public struct Event : EventInfoRecord, Encodable
  • User data required when generating an AuthenticationToken for a subscription attempt to a presence channel.

    See more

    Declaration

    Swift

    public struct PresenceUserData : Encodable
  • An information record for a specific user currently subscribed to a presence Channel.

    See more

    Declaration

    Swift

    public struct User : UserInfoRecord, Decodable
  • A representation of a Webhook that contains an array of events related to changes in the internal state of a Pusher Channels application, which were received as a POST request to a user-specified Webhook URL.

    The contained events have been verified as geniune Webhooks that were received directly from Pusher.

    See more

    Declaration

    Swift

    public struct Webhook : Codable
  • An event that is contained within a received Webhook.

    See more

    Declaration

    Swift

    public struct WebhookEvent : WebhookEventRecord, Codable
  • A collection of configuration options for a Pusher Channels HTTP API client.

    See more

    Declaration

    Swift

    public struct PusherClientOptions