Pusher Class Reference


                    
                    
                    connection

Undocumented

Declaration

Swift

public let connection: PusherConnection

Show on GitHub


                    
                    
                    delegate

Undocumented

Declaration

Swift

open weak var delegate: PusherDelegate? { get set }

Show on GitHub


                    
                    
                    init(key:options:)

Initializes the Pusher client with an app key and any appropriate options.

Declaration

Swift

public init(key: String, options: PusherClientOptions = PusherClientOptions())

Parameters

`key`	The Pusher app key
`options`	An optional collection of options

Return Value

A new Pusher client instance

Show on GitHub


                    
                    
                    subscribe(_:auth:onMemberAdded:onMemberRemoved:onSubscriptionCountChanged:)

Subscribes the client to a new channel

Declaration

Swift

open func subscribe(
    _ channelName: String,
    auth: PusherAuth? = nil,
    onMemberAdded: ((PusherPresenceChannelMember) -> Void)? = nil,
    onMemberRemoved: ((PusherPresenceChannelMember) -> Void)? = nil,
    onSubscriptionCountChanged: ((Int) -> Void)? = nil
) -> PusherChannel

Parameters

`channelName`	The name of the channel to subscribe to
`auth`	A PusherAuth value if subscription is being made to an authenticated channel without using the default auth methods
`onMemberAdded`	A function that will be called with information about the member who has just joined the presence channel
`onMemberRemoved`	A function that will be called with information about the member who has just left the presence channel

Return Value

A new PusherChannel instance

Show on GitHub


                    
                    
                    subscribeToPresenceChannel(channelName:auth:onMemberAdded:onMemberRemoved:onSubscriptionCountChanged:)

Subscribes the client to a new presence channel. Use this instead of the subscribe function when you want a presence channel object to be returned instead of just a generic channel object (which you can then cast)

Declaration

Swift

open func subscribeToPresenceChannel(
    channelName: String,
    auth: PusherAuth? = nil,
    onMemberAdded: ((PusherPresenceChannelMember) -> Void)? = nil,
    onMemberRemoved: ((PusherPresenceChannelMember) -> Void)? = nil,
    onSubscriptionCountChanged: ((Int) -> Void)? = nil
) -> PusherPresenceChannel

Parameters

`channelName`	The name of the channel to subscribe to
`auth`	A PusherAuth value if subscription is being made to an authenticated channel without using the default auth methods
`onMemberAdded`	A function that will be called with information about the member who has just joined the presence channel
`onMemberRemoved`	A function that will be called with information about the member who has just left the presence channel

Return Value

A new PusherPresenceChannel instance

Show on GitHub


                    
                    
                    unsubscribe(_:)

Unsubscribes the client from a given channel

Declaration

Swift

open func unsubscribe(_ channelName: String)

Parameters


                                channelName

The name of the channel to unsubscribe from

Show on GitHub


                    
                    
                    unsubscribeAll()

Unsubscribes the client from all channels

Declaration

Swift

open func unsubscribeAll()

Show on GitHub


                    
                    
                    bind(eventCallback:)

Binds the client’s global channel to all events

Declaration

Swift

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

Parameters


                                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 string that can be used to unbind the callback from the client

Show on GitHub


                    
                    
                    unbind(callbackId:)

Unbinds the client from its global channel

Declaration

Swift

open func unbind(callbackId: String)

Parameters


                                callbackId

The unique callbackId string used to identify which callback to unbind

Show on GitHub


                    
                    
                    unbindAll()

Unbinds the client from all global callbacks

Declaration

Swift

open func unbindAll()

Show on GitHub


                    
                    
                    disconnect()

Disconnects the client’s connection

Declaration

Swift

open func disconnect()

Show on GitHub


                    
                    
                    connect()

Initiates a connection attempt using the client’s existing connection details

Declaration

Swift

open func connect()

Show on GitHub


                    
                    
                    subscribe(channelName:)

Undocumented

Declaration

Swift

func subscribe(channelName: String) -> PusherChannel

Show on GitHub


                    
                    
                    subscribe(channelName:onMemberAdded:onMemberRemoved:onSubscriptionCountChanged:)

Undocumented

Declaration

Swift

func subscribe(
    channelName: String,
    onMemberAdded: ((PusherPresenceChannelMember) -> Void)? = nil,
    onMemberRemoved: ((PusherPresenceChannelMember) -> Void)? = nil,
    onSubscriptionCountChanged: ((Int) -> Void)? = nil
) -> PusherChannel

Show on GitHub


                    
                    
                    subscribeToPresenceChannel(channelName:)

Undocumented

Declaration

Swift

func subscribeToPresenceChannel(channelName: String) -> PusherPresenceChannel

Show on GitHub


                    
                    
                    subscribeToPresenceChannel(channelName:onMemberAdded:onMemberRemoved:onSubscriptionCountChanged:)

Undocumented

Declaration

Swift

func subscribeToPresenceChannel(
    channelName: String,
    onMemberAdded: ((PusherPresenceChannelMember) -> Void)? = nil,
    onMemberRemoved: ((PusherPresenceChannelMember) -> Void)? = nil,
    onSubscriptionCountChanged: ((Int) -> Void)? = nil
) -> PusherPresenceChannel

Show on GitHub


                    
                    
                    init(withAppKey:options:)

Undocumented

Declaration

Swift

convenience init(withAppKey key: String, options: PusherClientOptions)

Show on GitHub


                    
                    
                    init(withKey:)

Undocumented

Declaration

Swift

convenience init(withKey key: String)

Show on GitHub