Class UserNotAllowedException

This exception informs the host system that an app has determined that an user is not allowed to perform a specific action.

Currently it is expected to be thrown by the following events:

IPreRoomCreatePrevent
IPreRoomUserJoined
IPreRoomUserLeave

Hierarchy

AppsEngineException
- UserNotAllowedException

Index

Constructors

Properties

message name stack? JSONRPC_ERROR_CODE prepareStackTrace? stackTraceLimit

Methods

getErrorInfo captureStackTrace

Constructors

constructor

new UserNotAllowedException(message?): UserNotAllowedException
Parameters
- Optional message: string
Returns UserNotAllowedException
Inherited from AppsEngineException.constructor
- Defined in src/definition/exceptions/AppsEngineException.ts:21

Properties

message

message: string

name

name: string = 'AppsEngineException'

`Optional` stack

stack?: string

`Static` JSONRPC_ERROR_CODE

JSONRPC_ERROR_CODE: number = -32070

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Methods

getErrorInfo

getErrorInfo(): {
message: string;
name: string;
}
Returns {
message: string;
name: string;
}
- message: string
- name: string
Inherited from AppsEngineException.getErrorInfo
- Defined in src/definition/exceptions/AppsEngineException.ts:26

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from AppsEngineException.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc