Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoomsClient

Client to call Rooms schema and mutation for rooms

Hierarchy

  • RoomsClient

Index

Properties

Methods

Properties

Private client

Methods

create

  • Create new room.

    client.rooms.create(['id'], { data: {
      name: 'newRoom',
      description: 'description'
    }}).then(v => {
      console.log(v)
    })

    If you want to change "exit room" link url to be along with your own application, you can update it by exitRoomLink.

    client.rooms.create(['id'], {
      data: {
        name: 'newRoom',
        description: 'description',
        exitRoomLink: 'https://yourown.application.com'
      }
    })

    Type parameters

    Parameters

    Returns Promise<Result<RoomResult<R, O, RM, RM_U, RM_U_UP, RM_U_UP_E>>>

delete

  • delete<R>(fields: R[], args: MutationDeleteRoomArgs): Promise<{ data: null | Pick<{ description: string; id: string; name: string }, R>; errors: undefined | ReadonlyArray<GraphQLError> }>
  • Delete a room.

    client.rooms.delete(['id'], { id: 'xxxxxxxxxxxx' }).then(v => {
      console.log(v)
    })

    Type parameters

    Parameters

    Returns Promise<{ data: null | Pick<{ description: string; id: string; name: string }, R>; errors: undefined | ReadonlyArray<GraphQLError> }>

get

  • get<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>(fields: R[], id: string, option?: RoomOption<R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>): Promise<Result<RoomResult<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>>>

list

  • list<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>(fields: R[], args?: ViewerRoomsArgs | undefined | null, option?: RoomOption<R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>): Promise<Result<RoomsResult<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E>>>

Generated using TypeDoc