foo-webview-sdk
    Preparing search index...

    Interface PlaylistIsLockedParams

    Parameters for playlist.isLocked. Report whether a playlist carries a lock. An index past the last playlist fails with INVALID_INDEX, a playlistGuid no playlist has with NOT_FOUND. Every failure to find the playlist, and giving both keys or a malformed GUID, carries isLocked false.

    interface PlaylistIsLockedParams {
        playlist?: number;
        playlistGuid?: string;
    }
    Index
    playlist? playlistGuid?
    playlist?: number

    Index of the playlist; omitted, the active playlist. With this omitted and no active playlist the call fails with NO_ACTIVE_ITEM.

    playlistGuid?: string

    Persistent unique identifier of a playlist (bracketed GUID, case-insensitive), used in place of a mutable index. Mutually exclusive with playlist; passing both or an invalid format fails with INVALID_PARAMS. Fails with NOT_FOUND if the playlist does not exist, never falling back. Invalid-format and not-found failures return the given GUID in details.playlistGuid.

    Settings
    Member Visibility

    On This Page
    Properties