56 lines
1.4 KiB
TypeScript
Executable File
56 lines
1.4 KiB
TypeScript
Executable File
import { Channel, PresenceChannel } from './../channel';
|
|
export declare abstract class Connector {
|
|
/**
|
|
* Default connector options.
|
|
*/
|
|
private _defaultOptions;
|
|
/**
|
|
* Connector options.
|
|
*/
|
|
options: any;
|
|
/**
|
|
* Create a new class instance.
|
|
*/
|
|
constructor(options: any);
|
|
/**
|
|
* Merge the custom options with the defaults.
|
|
*/
|
|
protected setOptions(options: any): any;
|
|
/**
|
|
* Extract the CSRF token from the page.
|
|
*/
|
|
protected csrfToken(): null | string;
|
|
/**
|
|
* Create a fresh connection.
|
|
*/
|
|
abstract connect(): void;
|
|
/**
|
|
* Get a channel instance by name.
|
|
*/
|
|
abstract channel(channel: string): Channel;
|
|
/**
|
|
* Get a private channel instance by name.
|
|
*/
|
|
abstract privateChannel(channel: string): Channel;
|
|
/**
|
|
* Get a presence channel instance by name.
|
|
*/
|
|
abstract presenceChannel(channel: string): PresenceChannel;
|
|
/**
|
|
* Leave the given channel, as well as its private and presence variants.
|
|
*/
|
|
abstract leave(channel: string): void;
|
|
/**
|
|
* Leave the given channel.
|
|
*/
|
|
abstract leaveChannel(channel: string): void;
|
|
/**
|
|
* Get the socket_id of the connection.
|
|
*/
|
|
abstract socketId(): string;
|
|
/**
|
|
* Disconnect from the Echo server.
|
|
*/
|
|
abstract disconnect(): void;
|
|
}
|