Current File : /home/ugotscom/kma/node_modules/laravel-echo/dist/channel/socketio-channel.d.ts
import { EventFormatter } from '../util';
import { Channel } from './channel';
/**
* This class represents a Socket.io channel.
*/
export declare class SocketIoChannel extends Channel {
/**
* The Socket.io client instance.
*/
socket: any;
/**
* The name of the channel.
*/
name: any;
/**
* Channel options.
*/
options: any;
/**
* The event formatter.
*/
eventFormatter: EventFormatter;
/**
* The event callbacks applied to the socket.
*/
events: any;
/**
* User supplied callbacks for events on this channel.
*/
private listeners;
/**
* Create a new class instance.
*/
constructor(socket: any, name: string, options: any);
/**
* Subscribe to a Socket.io channel.
*/
subscribe(): void;
/**
* Unsubscribe from channel and ubind event callbacks.
*/
unsubscribe(): void;
/**
* Listen for an event on the channel instance.
*/
listen(event: string, callback: Function): SocketIoChannel;
/**
* Stop listening for an event on the channel instance.
*/
stopListening(event: string, callback?: Function): SocketIoChannel;
/**
* Register a callback to be called anytime a subscription succeeds.
*/
subscribed(callback: Function): SocketIoChannel;
/**
* Register a callback to be called anytime an error occurs.
*/
error(callback: Function): SocketIoChannel;
/**
* Bind the channel's socket to an event and store the callback.
*/
on(event: string, callback: Function): SocketIoChannel;
/**
* Unbind the channel's socket from all stored event callbacks.
*/
unbind(): void;
/**
* Unbind the listeners for the given event.
*/
protected unbindEvent(event: string, callback?: Function): void;
}
Mini Shell