Private channels

Private channels should be used when access to the channel needs to be restricted in some way. In order for a user to subscribe to a private channel permission must be authorized. The authentication occurs via a HTTP Request to a configurable authentication url when the subscribemethod is called with a private- channel name. In the JavaScript client library the HTTP Request is executed via AJAX (see Authenticating Users).

When a subscription takes place the user authentication process will be triggered.

1
var privateChannel = pusher.subscribe(privateChannelName);

• privateChannelName (String)
• The name of the channel to subscribe to. Since it is a private channel the name must be prefixed with private-
• Returns
• A Channel object which events can be bound to. See binding to events for more information on the Channel object.

iOS

1
PTPusherPrivateChannel *private = [self.pusher subscribeToPrivateChannelNamed:privateChannelName];

• privateChannelName (String)
• The name of the channel to subscribe to. *This method will add the appropriate private- prefix to the channel name for you.*
• Returns
• A channel cast to the correct PTPusherChannel subclassPTPusherPrivateChannel which events can be bound to. See binding to events.

See unsubscribing from channels

See binding to events for general information about how to bind to events on a channel object.

You can bind to the following pusher: events on a private channel:

• pusher:subscription_succeeded
• pusher:subscription_error