PusherChannel

@objcMembers
open class PusherChannel : NSObject

Undocumented

Show on GitHub

  • Undocumented

    Declaration

    Swift

    open var eventHandlers: [String : [EventHandler]] { get set }
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public var subscriptionCount: Int? { get }
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    open var subscribed: Bool
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public let name: String
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    open weak var connection: PusherConnection?
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    open var unsentEvents: [QueuedClientEvent]
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public let type: PusherChannelType
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public var auth: PusherAuth?
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    open var onSubscriptionCountChanged: ((Int) -> Void)?
    Show on GitHub

  • Initializes a new PusherChannel with a given name and connection

    Declaration

    Swift

    public init(name: String, connection: PusherConnection, auth: PusherAuth? = nil, onSubscriptionCountChanged: ((Int) -> Void)? = nil)

    Parameters

    name

    The name of the channel
    connection

    The connection that this channel is relevant to
    auth

    A PusherAuth value if subscription is being made to an authenticated channel without using the default auth methods

    Return Value

    A new PusherChannel instance

    Show on GitHub

  • Binds a callback to a given event name, scoped to the PusherChannel the function is called on

    Declaration

    Swift

    @discardableResult
open func bind(eventName: String, eventCallback: @escaping (PusherEvent) -> Void) -> String

    Parameters

    eventName

    The name of the event to bind to
    eventCallback

    The function to call when a new event is received. The callback receives a PusherEvent, containing the event’s data payload and other properties.

    Return Value

    A unique callbackId that can be used to unbind the callback at a later time

    Show on GitHub

  • Unbinds the callback with the given callbackId from the given eventName, in the scope of the channel being acted upon

    Declaration

    Swift

    open func unbind(eventName: String, callbackId: String)

    Parameters

    eventName

    The name of the event from which to unbind
    callbackId

    The unique callbackId string used to identify which callback to unbind
    Show on GitHub

  • Unbinds all callbacks from the channel

    Declaration

    Swift

    open func unbindAll()
    Show on GitHub

  • Unbinds all callbacks for the given eventName from the channel

    Declaration

    Swift

    open func unbindAll(forEventName eventName: String)

    Parameters

    eventName

    The name of the event from which to unbind
    Show on GitHub

  • Calls the appropriate callbacks for the given eventName in the scope of the acted upon channel

    Declaration

    Swift

    open func handleEvent(event: PusherEvent)

    Parameters

    event

    The event received from the websocket
    Show on GitHub

  • If subscribed, immediately call the connection to trigger a client event with the given eventName and data, otherwise queue it up to be triggered upon successful subscription

    Declaration

    Swift

    open func trigger(eventName: String, data: Any)

    Parameters

    eventName

    The name of the event to trigger
    data

    The data to be sent as the message payload
    Show on GitHub