Skip to main content

updateUserSettings

Update user settings in real-time.

Overview

Use this method to change user settings dynamically while an event is already playing — for example, to hide a panel or disable a feature — without restarting the event. Returns a Promise you should await.

Method Signature

updateUserSettings(settings: IUserSettings): Promise<void>;

Parameters

ParameterTypeDescription
settingsIUserSettingsThe new user settings to apply.

Return Value

A Promise<void> that resolves once the new settings have been applied.

IUserSettings Interface

interface IUserSettings {
panels?: {
bets?: {
/** Hide the entire bets panel from panel selection */
hidePanel?: boolean;
/** Hide wager values (dollar amounts) in betting cards */
hideWagers?: boolean;
};
stats?: {
/** Hide the entire stats panel from panel selection */
hidePanel?: boolean;
};
keyPlays?: {
/** Hide the entire key plays panel from panel selection */
hidePanel?: boolean;
};
fantasy?: {
/** Hide the entire fantasy panel from panel selection */
hidePanel?: boolean;
};
shop?: {
/** Hide the entire shop panel from panel selection */
hidePanel?: boolean;
};
};
}

Example

const maestroEvent = SDK.getMaestroEventViewModel();

await maestroEvent.updateUserSettings({
panels: {
bets: { hidePanel: true },
},
});