1

ModuleClientAPIUser

Mees van der Wijk edited this page 2023-04-05 12:21:02 +02:00

Table of Contents

• ModuleClientApi - User
• Functions
• getName
• getOrganization
• hasName
• hasOrganization
• changeDetails
• getCameraID
• getMicrophoneID
• hasCameraID
• hasMicrophoneID
• isMobile
• isMobileOrTablet

ModuleClientApi - User

Class representing the ModuleClientAPI User.

Functions

getName

Get the name of the user.

api.getUser().getName(callback);

Argument	Type	Description
(Optional) callback	( name:string ):void	Show a popup when a user has not entered their name and receive the name via the callback.

Returns string Name of the user (only if callback is undefined)

getOrganization

Get the organization of the user.

api.getUser().getName(callback);

Argument	Type	Description
(Optional) callback	( name:string ):void	Show a popup when a user has not entered their organization and receive the organization via the callback.

Returns string Organization of the user (only if callback is undefined)

hasName

Check is the user has a name.

api.getUser().hasName();

Return boolean User has name

hasOrganization

Check is the user has a organization.

api.getUser().hasOrganization();

Return boolean User has organization

changeDetails

Show the change name dialog to the user.

api.getUser().changeDetails(callback);

Argument	Type	Description
callback	function	Function that will be called when the user finishes changing their details.

getCameraID

Get current select camera deviceID.

api.getUser().getCameraID();

Returns string Select camera device ID or null

getMicrophoneID

Get current select microphone deviceID.

api.getUser().getMicrophoneID();

Returns string Select microphone device ID or null

hasCameraID

Check if the user has a camera selected.

api.getUser().hasCameraID();

Returns boolean Camera is selected

hasMicrophoneID

Check if the user has a microphone selected.

api.getUser().hasMicrophoneID();

Returns boolean Microphone is selected

isMobile

Check if the user is watching from a mobile phone.

api.getUser().isMobile();

Returns boolean User is on mobile

isMobileOrTablet

Check if the user is watching from a mobile phone or from a tablet.

api.getUser().isMobileOrTablet();

Returns boolean User is on mobile or table

Getting Started

• Introduction
• Prerequisites
• Setting up server
• Config

Module Development

• Introduction
• V2 Module Structure
  • module.ts
• V1 Module Structure
  • module.json
• Development environment/Building
• Module Config
  • Property
  • Trigger
  • Condition
• Module Debugging
• GetiyoModuleTool
  • ModuleStore
• Bug/Feature Reporting
• Contact Details

ModuleServerAPI

• Introduction
• ModuleServerAPI
  • Database
  • Client
  • Property
  • Important Principals
  • Libs
    • LibWebSocket
      • Communication Standard
    • Axios

ModuleServerAPI GameLib

• Introduction
• GameLib
  • Room
  • Game
    • GamePlayer
    • Scoreboard
      • Details
      • State
  • GameLib CollisionSpace

ModuleClientAPI

• Introduction
• ModuleClientAPI
  • User
  • Property
  • Neighbor
    • Neighbor Results
  • GameLib
    • Controller
  • Important Principals

ModuleApi Shared

• RuntimeStorage
• Gamelib
  • GameLib GameDetails
  • GameLib EndScreen
  • GameLib TimeSpan
  • GameLib FrameCycle
  • GameLib Ratio

© Vix Entertainment 2023 - © Mooren Productief 2023 - All rights reserved