Class ThreeDDiceAPI

Used to communicate with the dddice API and live server. This is typically not initialized directly by a developer but created after calling ThreeDDice#connect.

Hierarchy

ThreeDDiceAPI

Index

Constructors

constructor

new ThreeDDiceAPI(apiKey?, appName?): ThreeDDiceAPI
The constructor of the ThreeDDiceAPI class
Parameters
- Optional apiKey: string
  
  The API key used to communicate with the server
- Optional appName: string
  
  Optional string to identify the application which is communicating with the API
Returns ThreeDDiceAPI

Properties

`Optional` roomSlug

roomSlug?: string

Room Slug

`Optional` userUuid

userUuid?: string

UUID of the connected user

diceBox

diceBox: {
list: ((filter?) => Promise<IApiResponse<"theme[]", ITheme[]>>);
next: (() => Promise<null | IApiResponse<"theme[]", ITheme[]>>);
} = ...

API DiceBox Actions

Type declaration

list: ((filter?) => Promise<IApiResponse<"theme[]", ITheme[]>>)
- - (filter?): Promise<IApiResponse<"theme[]", ITheme[]>>
  - List the themes in a user's dicebox
    Parameters
    - Optional filter: string
    Returns Promise<IApiResponse<"theme[]", ITheme[]>>
next: (() => Promise<null | IApiResponse<"theme[]", ITheme[]>>)
- - (): Promise<null | IApiResponse<"theme[]", ITheme[]>>
  - Returns Promise<null | IApiResponse<"theme[]", ITheme[]>>

roll

roll: {
    create: ((dice, options?) => Promise<IApiResponse<"roll", IRoll>>);
    get: ((id) => Promise<IApiResponse<"roll", IRoll>>);
    update: ((id, payload) => Promise<IApiResponse<"roll", IRoll>>);
    updateBulk: ((rolls) => Promise<IApiResponse<"roll[]", IRoll[]>>);
} = ...

API Roll Actions

Type declaration

create: ((dice, options?) => Promise<IApiResponse<"roll", IRoll>>)
- - (dice, options?): Promise<IApiResponse<"roll", IRoll>>
  - Create a new roll
    Parameters
    - dice: IDiceRoll[]
    - Optional options: Partial<IDiceRollOptions>
    Returns Promise<IApiResponse<"roll", IRoll>>
get: ((id) => Promise<IApiResponse<"roll", IRoll>>)
- - (id): Promise<IApiResponse<"roll", IRoll>>
  - Get a roll by ID
    Parameters
    - id: string
    Returns Promise<IApiResponse<"roll", IRoll>>
update: ((id, payload) => Promise<IApiResponse<"roll", IRoll>>)
- - (id, payload): Promise<IApiResponse<"roll", IRoll>>
  - Update a roll
    Parameters
    - id: string
    - payload: {
      dice: Partial<IDiceRoll>[];
      room?: string;
      }
      
      dice: Partial<IDiceRoll>[]
      
      Optional room?: string
    Returns Promise<IApiResponse<"roll", IRoll>>
updateBulk: ((rolls) => Promise<IApiResponse<"roll[]", IRoll[]>>)
- - (rolls): Promise<IApiResponse<"roll[]", IRoll[]>>
  - Bulk update rolls
    Parameters
    - rolls: {
          uuid: string;
          dice: Partial<IDiceRoll>[];
          room?: string;
      }[]
    Returns Promise<IApiResponse<"roll[]", IRoll[]>>

room

room: {
    list: (() => Promise<IApiResponse<"room[]", IRoom[]>>);
    create: (() => Promise<IApiResponse<"room", IRoom>>);
    get: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>);
    join: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>);
    leave: ((slug, participantId?) => Promise<IApiResponse<"room", IRoom>>);
    updateParticipant: ((slug, participantId, data) => Promise<IApiResponse<"room", IRoom>>);
    updateRolls: ((slug, dice) => Promise<any>);
    update: ((slug, room) => Promise<any>);
} = ...

API Room Actions

Type declaration

list: (() => Promise<IApiResponse<"room[]", IRoom[]>>)
- - (): Promise<IApiResponse<"room[]", IRoom[]>>
  - List all created or joined rooms
    
    Returns Promise<IApiResponse<"room[]", IRoom[]>>
create: (() => Promise<IApiResponse<"room", IRoom>>)
- - (): Promise<IApiResponse<"room", IRoom>>
  - Create a new room
    
    Returns Promise<IApiResponse<"room", IRoom>>
get: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>)
- - (slug, passcode?): Promise<IApiResponse<"room", IRoom>>
  - Get a room by ID
    Parameters
    - slug: string
      
      Room slug
    - Optional passcode: string
      
      Passcode for access is the room is private
    Returns Promise<IApiResponse<"room", IRoom>>
join: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>)
- - (slug, passcode?): Promise<IApiResponse<"room", IRoom>>
  - Join a room
    Parameters
    - slug: string
      
      Room slug
    - Optional passcode: string
      
      Passcode for entry if the room is private
    Returns Promise<IApiResponse<"room", IRoom>>
leave: ((slug, participantId?) => Promise<IApiResponse<"room", IRoom>>)
- - (slug, participantId?): Promise<IApiResponse<"room", IRoom>>
  - Leave a room
    Parameters
    - slug: string
      
      Room slug
    - Optional participantId: string
      
      Participant ID
    Returns Promise<IApiResponse<"room", IRoom>>
updateParticipant: ((slug, participantId, data) => Promise<IApiResponse<"room", IRoom>>)
- - (slug, participantId, data): Promise<IApiResponse<"room", IRoom>>
  - Update a participant
    Parameters
    - slug: string
      
      Room slug
    - participantId: number
      
      Participant ID
    - data: Partial<IRoomParticipant>
      
      Participant information
    Returns Promise<IApiResponse<"room", IRoom>>
updateRolls: ((slug, dice) => Promise<any>)
- - (slug, dice): Promise<any>
  - Update Room Rolls Automatically pickup dice from the board or unhide dice to players for all rolls in a room and for the current player.
    Parameters
    - slug: string
      
      Room slug
    - dice: {
      is_cleared: boolean;
      }
      
      object to patch onto the dice in the room
      
      is_cleared: boolean
    Returns Promise<any>
update: ((slug, room) => Promise<any>)
- - (slug, room): Promise<any>
  - Update Room Update data about the room like room name
    Parameters
    - slug: string
      
      Room slug
    - room: {
          name: string;
          is_public: boolean;
          passcode: string;
      }
      
      object containing room data to patch
      
      name: string
      
      room name to change to
      
      is_public: boolean
      
      set to true to make room public, false to make private
      
      passcode: string
      
      passcode to use for a private room (is_public == false)
    Returns Promise<any>

theme

theme: {
get: ((id) => Promise<IApiResponse<"theme", ITheme>>);
} = ...

API Theme Actions

Type declaration

get: ((id) => Promise<IApiResponse<"theme", ITheme>>)
- - (id): Promise<IApiResponse<"theme", ITheme>>
  - Get a theme by slug
    Parameters
    - id: string
    Returns Promise<IApiResponse<"theme", ITheme>>

user

user: {
get: (() => Promise<IApiResponse<"user", IUser>>);
guest: (() => Promise<IApiResponse<"string", string>>);
} = ...

API User Actions

Type declaration

get: (() => Promise<IApiResponse<"user", IUser>>)
- - (): Promise<IApiResponse<"user", IUser>>
  - Get authorized user
    
    Returns Promise<IApiResponse<"user", IUser>>
guest: (() => Promise<IApiResponse<"string", string>>)
- - (): Promise<IApiResponse<"string", string>>
  - Create a Guest User Account
    
    Returns Promise<IApiResponse<"string", string>>

Methods

connect

connect(roomSlug, roomPasscode?, userUuid?): ThreeDDiceAPI
Connect to the live server and begin listening to room events.

Note: Your user must be a participant in a room in order to listen to events, otherwise an error is thrown.
Parameters
- roomSlug: string
  
  Room slug to listen on
- Optional roomPasscode: string
  
  Private passcode to access room
- Optional userUuid: string
  
  Personal User UUID to listen to whispers
Returns ThreeDDiceAPI

disconnect

disconnect(): ThreeDDiceAPI
Disconnect from the live server and stop listening to room events.

Returns ThreeDDiceAPI

listen

listen(event, callback): ThreeDDiceAPI
Listen for an event and execute a callback.
Parameters
- event: RoomUpdated
  
  The event to listen on
- callback: RoomEventCallback
  
  The function to execute when the event is fired
Returns ThreeDDiceAPI

Throws
APIRoomConnectError
listen(event, callback): ThreeDDiceAPI
Parameters
- event: ThreeDDiceRollEvent
- callback: RollEventCallback
Returns ThreeDDiceAPI

onConnectionStateChange

onConnectionStateChange(callback): ThreeDDiceAPI
Execute a callback when the connection state changes.
Parameters
- callback: ((state) => any)
  
  The function to execute when the connection state changes
  - - (state): any
    - Parameters
      
      state: string
      
      Returns any
Returns ThreeDDiceAPI

Throws
APIConnectError if the live connection has not been established

onConnectionError

onConnectionError(callback): ThreeDDiceAPI
Execute a callback when the connection throws an error
Parameters
- callback: ConnectionErrorCallback
  
  The function to execute
Returns ThreeDDiceAPI

Throws
APIRoomConnectError if the room connection has not been established

onConnect

onConnect(callback): ThreeDDiceAPI
Execute a callback when a connection is established
Parameters
- callback: ConnectionCreatedCallback
  
  The function to execute
Returns ThreeDDiceAPI

Throws
APIRoomConnectError if the room connection has not been established

onParticipantConnect

onParticipantConnect(callback): ThreeDDiceAPI
Execute a callback when a participant connection is established.

This is called once per participant connection, excluding your own connection.
Parameters
- callback: ConnectionUpdatedCallback
  
  The function to execute
Returns ThreeDDiceAPI

Throws
APIRoomConnectError if the room connection has not been established

onParticipantDisconnect

onParticipantDisconnect(callback): ThreeDDiceAPI
Execute a callback when a participant connection is lost or disconnected

This is called once per participant connection, excluding your own connection.
Parameters
- callback: ConnectionUpdatedCallback
  
  The function to execute
Returns ThreeDDiceAPI

Throws
APIRoomConnectError if the room connection has not been established

sendLocal

sendLocal(eventName, data): void
Parameters
- eventName: string
- data: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void

listenLocal

listenLocal(event, callback): ThreeDDiceAPI
Parameters
- event: string
- callback: LocalEventCallback
Returns ThreeDDiceAPI

Class ThreeDDiceAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional apiKey: string

Optional appName: string

Returns ThreeDDiceAPI

Properties

Optional roomSlug

Optional userUuid

diceBox

Type declaration

list: ((filter?) => Promise<IApiResponse<"theme[]", ITheme[]>>)

Parameters

Optional filter: string

Returns Promise<IApiResponse<"theme[]", ITheme[]>>

next: (() => Promise<null | IApiResponse<"theme[]", ITheme[]>>)

Returns Promise<null | IApiResponse<"theme[]", ITheme[]>>

roll

Type declaration

create: ((dice, options?) => Promise<IApiResponse<"roll", IRoll>>)

Parameters

dice: IDiceRoll[]

Optional options: Partial<IDiceRollOptions>

Returns Promise<IApiResponse<"roll", IRoll>>

get: ((id) => Promise<IApiResponse<"roll", IRoll>>)

Parameters

id: string

Returns Promise<IApiResponse<"roll", IRoll>>

update: ((id, payload) => Promise<IApiResponse<"roll", IRoll>>)

Parameters

id: string

payload: { dice: Partial<IDiceRoll>[]; room?: string; }

dice: Partial<IDiceRoll>[]

Optional room?: string

Returns Promise<IApiResponse<"roll", IRoll>>

updateBulk: ((rolls) => Promise<IApiResponse<"roll[]", IRoll[]>>)

Parameters

rolls: { uuid: string; dice: Partial<IDiceRoll>[]; room?: string; }[]

Returns Promise<IApiResponse<"roll[]", IRoll[]>>

room

Type declaration

list: (() => Promise<IApiResponse<"room[]", IRoom[]>>)

Returns Promise<IApiResponse<"room[]", IRoom[]>>

create: (() => Promise<IApiResponse<"room", IRoom>>)

Returns Promise<IApiResponse<"room", IRoom>>

get: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>)

Parameters

slug: string

Optional passcode: string

Returns Promise<IApiResponse<"room", IRoom>>

join: ((slug, passcode?) => Promise<IApiResponse<"room", IRoom>>)

Parameters

slug: string

Optional passcode: string

Returns Promise<IApiResponse<"room", IRoom>>

leave: ((slug, participantId?) => Promise<IApiResponse<"room", IRoom>>)

Parameters

slug: string

Optional participantId: string

Returns Promise<IApiResponse<"room", IRoom>>

updateParticipant: ((slug, participantId, data) => Promise<IApiResponse<"room", IRoom>>)

Parameters

slug: string

participantId: number

data: Partial<IRoomParticipant>

Returns Promise<IApiResponse<"room", IRoom>>

updateRolls: ((slug, dice) => Promise<any>)

Parameters

slug: string

dice: { is_cleared: boolean; }

is_cleared: boolean

Returns Promise<any>

update: ((slug, room) => Promise<any>)

Parameters

`Optional` apiKey: string

`Optional` appName: string

`Optional` roomSlug

`Optional` userUuid

`Optional` filter: string

`Optional` options: Partial<IDiceRollOptions>

payload: {
dice: Partial<IDiceRoll>[];
room?: string;
}

`Optional` room?: string

rolls: {
uuid: string;
dice: Partial<IDiceRoll>[];
room?: string;
}[]

`Optional` passcode: string

`Optional` passcode: string

`Optional` participantId: string

dice: {
is_cleared: boolean;
}

room: {
name: string;
is_public: boolean;
passcode: string;
}

`Optional` roomPasscode: string

`Optional` userUuid: string

data: {
[key: string]: any;
}