Interface WebcastAPI

Webcast API methods

See

Webcast API Docs

interface WebcastAPI {
    get uploadBackgroundImage(): (
        eventId: string,
        file: FileUploadType,
        options: ImageOptions,
    ) => Promise<void>;
    get uploadBranding(): (
        eventId: string,
        request: BrandingRequest,
        options?: ImageOptions,
    ) => Promise<void>;
    get uploadPresentation(): (
        eventId: string,
        file: FileUploadType,
        options: PresentationChaptersOptions,
    ) => Promise<void>;
    get uploadProducerLayoutBackground(): (
        eventId: string,
        file: FileUploadType,
        options: ImageOptions,
    ) => Promise<void>;
    addBanner(
        eventId: string,
        banner: WebcastBanner.Request,
    ): Promise<WebcastBanner>;
    addEmbeddedEngagement(
        eventId: string,
        contentLink: Webcast.ContentLink.Request,
    ): Promise<Webcast.ContentLink>;
    attendees(
        eventId: string,
        runNumber?: number,
        options?: Rev.SearchOptions<PostEventSession>,
    ): PostEventReportRequest;
    bulkDelete(
        query: Pick<
            Webcast.SearchRequest,
            "customFields"
            | "startDate"
            | "endDate",
        >,
        options?: RequestOptions,
    ): Promise<Webcast.BulkDelete.Response>;
    bulkDeleteStatus(jobId: string): Promise<Webcast.BulkDelete.Status>;
    comments(eventId: string, runNumber?: number): Promise<Webcast.Comment[]>;
    create(event: Webcast.CreateRequest): Promise<string>;
    createGuestRegistration(
        eventId: string,
        registration: GuestRegistration.Request,
    ): Promise<GuestRegistration.Details>;
    delete(eventId: string): Promise<void>;
    deleteBackgroundImage(eventId: string): Promise<void>;
    deleteBanner(eventId: string, bannerId: string): Promise<void>;
    deleteEmbeddedEngagement(eventId: string, linkId: string): Promise<void>;
    deleteGuestRegistration(
        eventId: string,
        registrationId: string,
    ): Promise<void>;
    deleteProducerLayoutBackground(eventId: string): Promise<void>;
    details(
        eventId: string,
        requestOptions?: RequestOptions,
    ): Promise<Webcast.Details>;
    edit(eventId: string, event: Webcast.CreateRequest): Promise<void>;
    editAccess(eventId: string, entities: EditAttendeesRequest): Promise<void>;
    guestRegistration(
        eventId: string,
        registrationId: string,
    ): Promise<GuestRegistration.Details>;
    hideComment(
        eventId: string,
        commentId: string,
        runNumber?: number,
    ): Promise<void>;
    isPublic(
        eventId: string,
        requestOptions?: RequestOptions,
    ): Promise<boolean>;
    linkVideo(
        eventId: string,
        videoId: string,
        autoRedirect?: boolean,
    ): Promise<any>;
    list(
        options?: ListRequest,
        requestOptions?: RequestOptions,
    ): Promise<Webcast[]>;
    listBanners(eventId: string): Promise<WebcastBanner[]>;
    listEmbeddedEngagements(eventId: string): Promise<Webcast.ContentLink[]>;
    listGuestRegistrations(
        eventId: string,
        query?: GuestRegistration.SearchRequest,
        options?: Rev.SearchOptions<GuestRegistration>,
    ): ISearchRequest<GuestRegistration>;
    muteAttendee(
        eventId: string,
        userId: string,
        runNumber?: number,
    ): Promise<void>;
    patch(
        eventId: string,
        operations: PatchOperation[],
        options?: RequestOptions,
    ): Promise<void>;
    patchGuestRegistration(
        eventId: string,
        registrationId: string,
        registration: Partial<GuestRegistration.Request>,
    ): Promise<void>;
    playbackUrl(
        eventId: string,
        options?: PlaybackUrlRequest,
    ): Promise<Webcast.Playback[]>;
    playbackUrls(
        eventId: string,
        __namedParameters?: PlaybackUrlRequest,
        options?: RequestOptions,
    ): Promise<Webcast.PlaybackUrlsResponse>;
    pollResults(eventId: string, runNumber?: number): Promise<PollResults[]>;
    questions(eventId: string, runNumber?: number): Promise<Question[]>;
    reactions(eventId: string): Promise<ReactionsSummary[]>;
    realtimeAttendees<T extends undefined | RealtimeRequest>(
        eventId: string,
        query?: T,
        options?: Rev.SearchOptions<RealtimeSession<T>>,
    ): RealtimeReportRequest<RealtimeSession<T>>;
    resendEmailToExternalPresenter(
        eventId: string,
        email: string,
    ): Promise<void>;
    search(
        query: Webcast.SearchRequest,
        options?: Rev.SearchOptions<Webcast>,
    ): ISearchRequest<Webcast>;
    setBannerStatus(
        eventId: string,
        bannerId: string,
        isEnabled: boolean,
    ): Promise<void>;
    setEmbeddedEngagementStatus(
        eventId: string,
        linkId: string,
        isEnabled: boolean,
    ): Promise<void>;
    startBroadcast(eventId: string): Promise<void>;
    startEvent(eventId: string, preProduction?: boolean): Promise<void>;
    startRecord(eventId: string): Promise<void>;
    status(
        eventId: string,
        requestOptions?: RequestOptions,
    ): Promise<Webcast.Status>;
    stopBroadcast(eventId: string): Promise<void>;
    stopEvent(eventId: string, preProduction?: boolean): Promise<void>;
    stopRecord(eventId: string): Promise<void>;
    unhideComment(
        eventId: string,
        commentId: string,
        runNumber?: number,
    ): Promise<void>;
    unlinkVideo(eventId: string): Promise<void>;
    unmuteAttendee(
        eventId: string,
        userId: string,
        runNumber?: number,
    ): Promise<void>;
    updateBanner(
        eventId: string,
        banner: WebcastBanner,
    ): Promise<WebcastBanner>;
    updateEmbeddedEngagement(
        eventId: string,
        contentLink: Webcast.ContentLink,
    ): Promise<Webcast.ContentLink>;
    updateGuestRegistration(
        eventId: string,
        registrationId: string,
        registration: GuestRegistration.Request,
    ): Promise<void>;
}

Hierarchy

  • API
    • WebcastAPI

Accessors

uploadBackgroundImage uploadBranding uploadPresentation uploadProducerLayoutBackground

Methods

addBanner addEmbeddedEngagement attendees bulkDelete bulkDeleteStatus comments create createGuestRegistration delete deleteBackgroundImage deleteBanner deleteEmbeddedEngagement deleteGuestRegistration deleteProducerLayoutBackground details edit editAccess guestRegistration hideComment isPublic linkVideo list listBanners listEmbeddedEngagements listGuestRegistrations muteAttendee patch patchGuestRegistration playbackUrl playbackUrls pollResults questions reactions realtimeAttendees resendEmailToExternalPresenter search setBannerStatus setEmbeddedEngagementStatus startBroadcast startEvent startRecord status stopBroadcast stopEvent stopRecord unhideComment unlinkVideo unmuteAttendee updateBanner updateEmbeddedEngagement updateGuestRegistration

Accessors

uploadBackgroundImage

uploadBranding

uploadPresentation

uploadProducerLayoutBackground

Methods

addBanner

addEmbeddedEngagement

attendees

bulkDelete

  • bulkDelete(
        query: Pick<
            Webcast.SearchRequest,
            "customFields"
            | "startDate"
            | "endDate",
        >,
        options?: RequestOptions,
    ): Promise<Webcast.BulkDelete.Response>

  • This endpoint deletes all events for a given date range or custom field query. The response returns a jobId and a count of webcasts to be deleted. The jobId can be used to check the status of the deletion.

    Parameters

    • query: Pick<Webcast.SearchRequest, "customFields" | "startDate" | "endDate">

      Fields that are going to be used to search Webcasts that are to be deleted.

    • Optionaloptions: RequestOptions

    Returns Promise<Webcast.BulkDelete.Response>

bulkDeleteStatus

comments

create

createGuestRegistration

delete

  • delete(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

deleteBackgroundImage

  • deleteBackgroundImage(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

deleteBanner

  • deleteBanner(eventId: string, bannerId: string): Promise<void>

  • Parameters

    • eventId: string
    • bannerId: string

    Returns Promise<void>

deleteEmbeddedEngagement

  • deleteEmbeddedEngagement(eventId: string, linkId: string): Promise<void>

  • Parameters

    • eventId: string
    • linkId: string

    Returns Promise<void>

deleteGuestRegistration

  • deleteGuestRegistration(eventId: string, registrationId: string): Promise<void>

  • Parameters

    • eventId: string
    • registrationId: string

    Returns Promise<void>

deleteProducerLayoutBackground

  • deleteProducerLayoutBackground(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

details

edit

editAccess

guestRegistration

  • guestRegistration(
        eventId: string,
        registrationId: string,
    ): Promise<GuestRegistration.Details>

  • Retrieve details of a specific guest user Public webcast registration.

    Parameters

    • eventId: string

      Id of the Public webcast

    • registrationId: string

      Id of guest user's registration to retrieve

    Returns Promise<GuestRegistration.Details>

hideComment

  • hideComment(
        eventId: string,
        commentId: string,
        runNumber?: number,
    ): Promise<void>

  • Hide specific comment for a specified webcast

    Parameters

    • eventId: string
    • commentId: string
    • OptionalrunNumber: number

    Returns Promise<void>

isPublic

linkVideo

  • linkVideo(
        eventId: string,
        videoId: string,
        autoRedirect?: boolean,
    ): Promise<any>

  • Parameters

    • eventId: string
    • videoId: string
    • autoRedirect: boolean = true

    Returns Promise<any>

list

listBanners

listEmbeddedEngagements

listGuestRegistrations

muteAttendee

  • muteAttendee(eventId: string, userId: string, runNumber?: number): Promise<void>

  • Mute attendee for a specified webcast

    Parameters

    • eventId: string
    • userId: string
    • OptionalrunNumber: number

    Returns Promise<void>

patch

  • patch(
        eventId: string,
        operations: PatchOperation[],
        options?: RequestOptions,
    ): Promise<void>

  • Partially edits the details of a webcast. You do not need to provide the fields that you are not changing. Webcast status determines which fields are modifiable and when.

    If the webcast pre-production or main event is in progress, only fields available for inline editing may be patched/edited.

    If the webcast main event has been run once, only fields available after the webcast has ended are available for editing. That includes all fields with the exception of start/end dates, lobbyTimeMinutes, preProduction, duration, userIds, and groupIds.

    If the webcast end time has passed and is Completed, only edits to linkedVideoId and redirectVod are allowed.

    Event Admins can be removed using their email addresses as path pointer for the fields 'EventAdminEmails' and 'EventAdmins', provided that all of the Event Admins associated with the webcast have email addresses. This is also applicable for the field 'Moderators'.

    Parameters

    Returns Promise<void>

    Example

    const rev = new RevClient(...config...);
    await rev.connect();

    // using eventadmins
    await rev.webcast.patch(eventId, [{ 'op': 'remove', 'path': '/EventAdmins/Email', 'value': 'x1@test.com' }]);
    // change shortcut
    await rev.webcast.patch(eventId, [{ 'op': 'replace', 'path': '/ShortcutName', 'value': 'weekly-meeting' }]);

patchGuestRegistration

playbackUrl

playbackUrls

pollResults

questions

  • questions(eventId: string, runNumber?: number): Promise<Question[]>

  • Parameters

    • eventId: string
    • OptionalrunNumber: number

    Returns Promise<Question[]>

reactions

realtimeAttendees

resendEmailToExternalPresenter

  • resendEmailToExternalPresenter(eventId: string, email: string): Promise<void>

  • Resend email to external presenters for Producer type webcast.

    Parameters

    • eventId: string

      id of the webcast

    • email: string

      Email of the external presenter.

    Returns Promise<void>

search

setBannerStatus

  • setBannerStatus(
        eventId: string,
        bannerId: string,
        isEnabled: boolean,
    ): Promise<void>

  • Parameters

    • eventId: string
    • bannerId: string
    • isEnabled: boolean

    Returns Promise<void>

setEmbeddedEngagementStatus

  • setEmbeddedEngagementStatus(
        eventId: string,
        linkId: string,
        isEnabled: boolean,
    ): Promise<void>

  • Parameters

    • eventId: string
    • linkId: string
    • isEnabled: boolean

    Returns Promise<void>

startBroadcast

  • startBroadcast(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

startEvent

  • startEvent(eventId: string, preProduction?: boolean): Promise<void>

  • Parameters

    • eventId: string
    • preProduction: boolean = false

    Returns Promise<void>

startRecord

  • startRecord(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

status

stopBroadcast

  • stopBroadcast(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

stopEvent

  • stopEvent(eventId: string, preProduction?: boolean): Promise<void>

  • Parameters

    • eventId: string
    • preProduction: boolean = false

    Returns Promise<void>

stopRecord

  • stopRecord(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

unhideComment

  • unhideComment(
        eventId: string,
        commentId: string,
        runNumber?: number,
    ): Promise<void>

  • Unhide specific comment for a specified webcast

    Parameters

    • eventId: string
    • commentId: string
    • OptionalrunNumber: number

    Returns Promise<void>

unlinkVideo

  • unlinkVideo(eventId: string): Promise<void>

  • Parameters

    • eventId: string

    Returns Promise<void>

unmuteAttendee

  • unmuteAttendee(
        eventId: string,
        userId: string,
        runNumber?: number,
    ): Promise<void>

  • Unmute attendee for a specified webcast

    Parameters

    • eventId: string
    • userId: string
    • OptionalrunNumber: number

    Returns Promise<void>

updateBanner

updateEmbeddedEngagement

updateGuestRegistration

Settings

Member Visibility

On This Page

Accessors
Methods