WhiteEvent Class Reference

Inherits from WhiteObject
Declared in WhiteEvent.h

Overview

Custom event callbacks that can be triggered by the SDK.

– initWithName:payload:

Sets the name and content of the callback event and initializes a WhiteEvent object.

- (instancetype)initWithName:(NSString *)eventName payload:(id)payload

Parameters

eventName

The name of the event.
payload

The content of the event.

Return Value

An initialized WhiteEvent object.

Declared In

WhiteEvent.h

  eventName

The name of the event.

@property (nonatomic, strong) NSString *eventName

Declared In

WhiteEvent.h

  payload

The content of the event.

@property (nonatomic, strong, nullable) id payload

Declared In

WhiteEvent.h

  uuid

Room UUID, the unique identifier of a room.

@property (nonatomic, strong, readonly) NSString *uuid

Declared In

WhiteEvent.h

  scope

The role of the user who triggers the event, including system, app, custom, magix.

@property (nonatomic, strong, readonly) NSString *scope

Declared In

WhiteEvent.h

  authorId

The user ID of the event trigger.

@property (nonatomic, strong, readonly) NSString *authorId

Declared In

WhiteEvent.h