Interface AdminAPI

The Admin API methods

See

Administration API Docs

interface AdminAPI {
    brandingSettings(): Promise<Admin.BrandingSettings>;
    createWebcastRegistrationField(
        registrationField: RegistrationField.Request,
    ): Promise<string>;
    customFields(cache?: {}): Promise<Admin.CustomField[]>;
    deleteWebcastRegistrationField(fieldId: string): Promise<void>;
    expirationRules(): Promise<ExpirationRule[]>;
    featureSettings(videoId?: string): Promise<FeatureSettings>;
    getCustomFieldByName(
        name: string,
        fromCache?: {},
    ): Promise<Admin.CustomField>;
    getRoleByName(
        name:
            | string & Record<never, never>
            | "AccountAdmin"
            | "MediaAdmin"
            | "EventAdmin"
            | "EventHost"
            | "InternalEventHost"
            | "MediaContributor"
            | "InternalMediaContributor"
            | "MediaViewer"
            | "TeamCreator"
            | "CategoryCreator"
            | "VodAnalyst"
            | "EventAnalyst"
            | "RevIqUser"
            | "ChannelCreator"
            | "MediaUploader"
            | "InternalMediaUploader"
            | "Account Admin"
            | "Media Admin"
            | "Media Contributor"
            | "Media Viewer"
            | "Event Admin"
            | "Event Host"
            | "Channel Creator"
            | "Category Creator"
            | "Internal Event Host"
            | "Internal Media Contributor"
            | "VOD Analyst"
            | "Event Analyst"
            | "Rev IQ User"
            | "Media Uploader"
            | "Internal Media Uploader",
        fromCache?: {},
    ): Promise<Role>;
    listIQCreditsUsage(
        query: { endDate?: string | Date; startDate?: string | Date },
        options?: Rev.SearchOptions<IQCreditsSession>,
    ): ISearchRequest<IQCreditsSession>;
    maintenanceSchedule(): Promise<{ end: string; start: string }[]>;
    roles(cache?: {}): Promise<Role.Details[]>;
    updateWebcastRegistrationField(
        fieldId: string,
        registrationField: Partial<RegistrationField.Request>,
    ): Promise<void>;
    userLocationService(): Promise<
        { enabled: boolean; locationUrls: string[] },
    >;
    verifySystemHealth(): Promise<boolean>;
    webcastRegistrationFields(): Promise<RegistrationField & { id: string }>;
}

Hierarchy

  • API
    • AdminAPI

Methods

brandingSettings createWebcastRegistrationField customFields deleteWebcastRegistrationField expirationRules featureSettings getCustomFieldByName getRoleByName listIQCreditsUsage maintenanceSchedule roles updateWebcastRegistrationField userLocationService verifySystemHealth webcastRegistrationFields

Methods

brandingSettings

createWebcastRegistrationField

customFields

  • customFields(cache?: {}): Promise<Admin.CustomField[]>

  • get list of custom fields

    Parameters

    • cache: {} = true

      if true allow storing/retrieving from cached values. 'Force' means refresh value saved in cache

    Returns Promise<Admin.CustomField[]>

deleteWebcastRegistrationField

  • deleteWebcastRegistrationField(fieldId: string): Promise<void>

  • Parameters

    • fieldId: string

    Returns Promise<void>

expirationRules

featureSettings

getCustomFieldByName

  • getCustomFieldByName(name: string, fromCache?: {}): Promise<Admin.CustomField>

  • Get a Custom Field based on its name

    Parameters

    • name: string

      name of the Custom Field

    • fromCache: {} = true

      if true then use previously cached Role listing (more efficient)

    Returns Promise<Admin.CustomField>

getRoleByName

  • getRoleByName(
        name:
            | string & Record<never, never>
            | "AccountAdmin"
            | "MediaAdmin"
            | "EventAdmin"
            | "EventHost"
            | "InternalEventHost"
            | "MediaContributor"
            | "InternalMediaContributor"
            | "MediaViewer"
            | "TeamCreator"
            | "CategoryCreator"
            | "VodAnalyst"
            | "EventAnalyst"
            | "RevIqUser"
            | "ChannelCreator"
            | "MediaUploader"
            | "InternalMediaUploader"
            | "Account Admin"
            | "Media Admin"
            | "Media Contributor"
            | "Media Viewer"
            | "Event Admin"
            | "Event Host"
            | "Channel Creator"
            | "Category Creator"
            | "Internal Event Host"
            | "Internal Media Contributor"
            | "VOD Analyst"
            | "Event Analyst"
            | "Rev IQ User"
            | "Media Uploader"
            | "Internal Media Uploader",
        fromCache?: {},
    ): Promise<Role>

  • Get a Role (with the role id) based on its name

    Parameters

    • name:
          | string & Record<never, never>
          | "AccountAdmin"
          | "MediaAdmin"
          | "EventAdmin"
          | "EventHost"
          | "InternalEventHost"
          | "MediaContributor"
          | "InternalMediaContributor"
          | "MediaViewer"
          | "TeamCreator"
          | "CategoryCreator"
          | "VodAnalyst"
          | "EventAnalyst"
          | "RevIqUser"
          | "ChannelCreator"
          | "MediaUploader"
          | "InternalMediaUploader"
          | "Account Admin"
          | "Media Admin"
          | "Media Contributor"
          | "Media Viewer"
          | "Event Admin"
          | "Event Host"
          | "Channel Creator"
          | "Category Creator"
          | "Internal Event Host"
          | "Internal Media Contributor"
          | "VOD Analyst"
          | "Event Analyst"
          | "Rev IQ User"
          | "Media Uploader"
          | "Internal Media Uploader"

      Name of the Role OR RoleType. You can specify the specific enum value (preferred, only Rev 7.53+), or the localized string value in the current user's language, i.e. "Media Viewer" for english

    • fromCache: {} = true

      if true then use previously cached Role listing (more efficient)

    Returns Promise<Role>

listIQCreditsUsage

maintenanceSchedule

  • maintenanceSchedule(): Promise<{ end: string; start: string }[]>

  • gets list of scheduled maintenance windows

    Returns Promise<{ end: string; start: string }[]>

roles

  • roles(cache?: {}): Promise<Role.Details[]>

  • get mapping of role names to role IDs

    Parameters

    • cache: {} = true

      if true allow storing/retrieving from cached values. 'Force' means refresh value saved in cache

    Returns Promise<Role.Details[]>

updateWebcastRegistrationField

userLocationService

  • userLocationService(): Promise<{ enabled: boolean; locationUrls: string[] }>

  • gets the user location service URL

    Returns Promise<{ enabled: boolean; locationUrls: string[] }>

verifySystemHealth

  • verifySystemHealth(): Promise<boolean>

  • get system health - returns 200 if system is active and responding, otherwise throws error

    Returns Promise<boolean>

webcastRegistrationFields

Settings

Member Visibility

On This Page

Methods