Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias ForceKeepAliveMessage

    Force keep alive websocket messages.

    type ForceKeepAliveMessage = {
        Data?: number;
        MessageId?: string;
        MessageType?:
            | "ForceKeepAlive"
            | "GeneralCommand"
            | "UserDataChanged"
            | "Sessions"
            | "Play"
            | "SyncPlayCommand"
            | "SyncPlayGroupUpdate"
            | "Playstate"
            | "RestartRequired"
            | "ServerShuttingDown"
            | "ServerRestarting"
            | "LibraryChanged"
            | "UserDeleted"
            | "UserUpdated"
            | "SeriesTimerCreated"
            | "TimerCreated"
            | "SeriesTimerCancelled"
            | "TimerCancelled"
            | "RefreshProgress"
            | "ScheduledTaskEnded"
            | "PackageInstallationCancelled"
            | "PackageInstallationFailed"
            | "PackageInstallationCompleted"
            | "PackageInstalling"
            | "PackageUninstalled"
            | "ActivityLogEntry"
            | "ScheduledTasksInfo"
            | "ActivityLogEntryStart"
            | "ActivityLogEntryStop"
            | "SessionsStart"
            | "SessionsStop"
            | "ScheduledTasksInfoStart"
            | "ScheduledTasksInfoStop"
            | "KeepAlive";
    }
    Index
    Data?: number

    Gets or sets the data.

    MessageId?: string

    Gets or sets the message id.

    MessageType?:
        | "ForceKeepAlive"
        | "GeneralCommand"
        | "UserDataChanged"
        | "Sessions"
        | "Play"
        | "SyncPlayCommand"
        | "SyncPlayGroupUpdate"
        | "Playstate"
        | "RestartRequired"
        | "ServerShuttingDown"
        | "ServerRestarting"
        | "LibraryChanged"
        | "UserDeleted"
        | "UserUpdated"
        | "SeriesTimerCreated"
        | "TimerCreated"
        | "SeriesTimerCancelled"
        | "TimerCancelled"
        | "RefreshProgress"
        | "ScheduledTaskEnded"
        | "PackageInstallationCancelled"
        | "PackageInstallationFailed"
        | "PackageInstallationCompleted"
        | "PackageInstalling"
        | "PackageUninstalled"
        | "ActivityLogEntry"
        | "ScheduledTasksInfo"
        | "ActivityLogEntryStart"
        | "ActivityLogEntryStop"
        | "SessionsStart"
        | "SessionsStop"
        | "ScheduledTasksInfoStart"
        | "ScheduledTasksInfoStop"
        | "KeepAlive"

    The different kinds of messages that are used in the WebSocket api.