Options
All
  • Public
  • Public/Protected
  • All
Menu

Class socketio

class
classdesc

Consists of socket related methods

Hierarchy

  • socketio

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private socket

socket: any = io(appConfig.server_url, {transports: ["websocket"]})

Private socketRespones

socketRespones: Array<any> = []

Methods

disconnectSocket

  • disconnectSocket(): void

getData

  • getData(type: string, data?: any): Promise<Object>
  • function

    getData

    description

    Gets data via socket api requests

    Parameters

    • type: string

      type of socket api request(a string)

    • Optional data: any

      Data to be sent

    Returns Promise<Object>

    A Promise object

joinGroup

  • joinGroup(group_id: string): void
  • function

    joinGroup

    description

    Socket joins a group.

    Parameters

    • group_id: string

      Conversation group ID

    Returns void

joinUser

  • joinUser(): Promise<Object>

leaveGroup

  • leaveGroup(group_id: string): void
  • function

    leaveGroup

    description

    Socket leaves a group.

    Parameters

    • group_id: string

      Conversation group ID

    Returns void

Private registerSocketIoResponse

  • registerSocketIoResponse(): void
  • function

    registerSocketIoResponse

    description

    Various socket events for connection

    Returns void

sendData

  • sendData(type: string, data?: any): void
  • function

    sendData

    description

    Make a socket api request.

    Parameters

    • type: string

      Type of socket (a string value)

    • Optional data: any

      Data to be sent to socket api

    Returns void

subscribe

  • subscribe(type: string, callback: any): number

unsubscribe

  • unsubscribe(ids: Array<number> | any): void