Reviews class

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

@azure/cognitiveservices-contentmoderator

Class representing a Reviews.

Constructors

Reviews(ContentModeratorClientContext)

Create a Reviews.

Methods

addVideoFrame(string, string, Models.ReviewsAddVideoFrameOptionalParams)	The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. CallBack Schemas Review Completion CallBack Sample { "ReviewId": " .
addVideoFrame(string, string, ReviewsAddVideoFrameOptionalParams, ServiceCallback<void>)
addVideoFrame(string, string, ServiceCallback<void>)
addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, Models.ReviewsAddVideoFrameStreamOptionalParams)	Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.
addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, ReviewsAddVideoFrameStreamOptionalParams, ServiceCallback<void>)
addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, ServiceCallback<void>)
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], Models.ReviewsAddVideoFrameUrlOptionalParams)	Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ReviewsAddVideoFrameUrlOptionalParams, ServiceCallback<void>)
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ServiceCallback<void>)
addVideoTranscript(string, string, msRest.HttpRequestBody, msRest.RequestOptionsBase)	This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.
addVideoTranscript(string, string, msRest.HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
addVideoTranscript(string, string, msRest.HttpRequestBody, ServiceCallback<void>)
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], msRest.RequestOptionsBase)	This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], RequestOptionsBase, ServiceCallback<void>)
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], ServiceCallback<void>)
createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, Models.ReviewsCreateJobOptionalParams)	A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. CallBack Schemas Job Completion CallBack Sample { "JobId": ", "ReviewId": "<Review Id, if the Job resulted in a Review to be created>", "WorkFlowId": "default", "Status": "<This will be one of Complete, InProgress, Error>", "ContentType": "Image", "ContentId": "", "CallBackType": "Job", "Metadata": { "adultscore": "0.xxx", "a": "False", "racyscore": "0.xxx", "r": "True" } } Review Completion CallBack Sample { "ReviewId": "", "ModifiedOn": "2016-10-11T22:36:32.9934851Z", "ModifiedBy": "", "CallBackType": "Review", "ContentId": "", "Metadata": { "adultscore": "0.xxx", "a": "False", "racyscore": "0.xxx", "r": "True" }, "ReviewerResultTags": { "a": "False", "r": "True" } } .
createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, ReviewsCreateJobOptionalParams, ServiceCallback<JobId>)
createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, ServiceCallback<JobId>)
createReviews(string, string, CreateReviewBodyItem[], Models.ReviewsCreateReviewsOptionalParams)	The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. CallBack Schemas Review Completion CallBack Sample { "ReviewId": " .
createReviews(string, string, CreateReviewBodyItem[], ReviewsCreateReviewsOptionalParams, ServiceCallback<string[]>)
createReviews(string, string, CreateReviewBodyItem[], ServiceCallback<string[]>)
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], Models.ReviewsCreateVideoReviewsOptionalParams)	The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. CallBack Schemas Review Completion CallBack Sample { "ReviewId": " .
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ReviewsCreateVideoReviewsOptionalParams, ServiceCallback<string[]>)
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ServiceCallback<string[]>)
getJobDetails(string, string, msRest.RequestOptionsBase)	Get the Job Details for a Job Id.
getJobDetails(string, string, RequestOptionsBase, ServiceCallback<Job>)
getJobDetails(string, string, ServiceCallback<Job>)
getReview(string, string, msRest.RequestOptionsBase)	Returns review details for the review Id passed.
getReview(string, string, RequestOptionsBase, ServiceCallback<Review>)
getReview(string, string, ServiceCallback<Review>)
getVideoFrames(string, string, Models.ReviewsGetVideoFramesOptionalParams)	The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. CallBack Schemas Review Completion CallBack Sample { "ReviewId": " .
getVideoFrames(string, string, ReviewsGetVideoFramesOptionalParams, ServiceCallback<Frames>)
getVideoFrames(string, string, ServiceCallback<Frames>)
publishVideoReview(string, string, msRest.RequestOptionsBase)	Publish video review to make it available for review.
publishVideoReview(string, string, RequestOptionsBase, ServiceCallback<void>)
publishVideoReview(string, string, ServiceCallback<void>)

Constructor Details

Reviews(ContentModeratorClientContext)

Create a Reviews.

new Reviews(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

addVideoFrame(string, string, Models.ReviewsAddVideoFrameOptionalParams)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

.

function addVideoFrame(teamName: string, reviewId: string, options?: Models.ReviewsAddVideoFrameOptionalParams): Promise<RestResponse>

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

Models.ReviewsAddVideoFrameOptionalParams

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addVideoFrame(string, string, ReviewsAddVideoFrameOptionalParams, ServiceCallback<void>)

function addVideoFrame(teamName: string, reviewId: string, options: ReviewsAddVideoFrameOptionalParams, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

ReviewsAddVideoFrameOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

addVideoFrame(string, string, ServiceCallback<void>)

function addVideoFrame(teamName: string, reviewId: string, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

callback

ServiceCallback<void>

The callback

addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, Models.ReviewsAddVideoFrameStreamOptionalParams)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: msRest.HttpRequestBody, frameMetadata: string, options?: Models.ReviewsAddVideoFrameStreamOptionalParams): Promise<RestResponse>

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

frameImageZip

msRest.HttpRequestBody

Zip file containing frame images.

frameMetadata

string

Metadata of the frame.

options

Models.ReviewsAddVideoFrameStreamOptionalParams

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, ReviewsAddVideoFrameStreamOptionalParams, ServiceCallback<void>)

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: msRest.HttpRequestBody, frameMetadata: string, options: ReviewsAddVideoFrameStreamOptionalParams, callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

frameImageZip

msRest.HttpRequestBody

Zip file containing frame images.

frameMetadata

string

Metadata of the frame.

options

ReviewsAddVideoFrameStreamOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

addVideoFrameStream(string, string, string, msRest.HttpRequestBody, string, ServiceCallback<void>)

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: msRest.HttpRequestBody, frameMetadata: string, callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

frameImageZip

msRest.HttpRequestBody

Zip file containing frame images.

frameMetadata

string

Metadata of the frame.

callback

ServiceCallback<void>

The callback

addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], Models.ReviewsAddVideoFrameUrlOptionalParams)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], options?: Models.ReviewsAddVideoFrameUrlOptionalParams): Promise<RestResponse>

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

videoFrameBody

VideoFrameBodyItem[]

Body for add video frames API

options

Models.ReviewsAddVideoFrameUrlOptionalParams

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ReviewsAddVideoFrameUrlOptionalParams, ServiceCallback<void>)

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], options: ReviewsAddVideoFrameUrlOptionalParams, callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

videoFrameBody

VideoFrameBodyItem[]

Body for add video frames API

options

ReviewsAddVideoFrameUrlOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ServiceCallback<void>)

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

videoFrameBody

VideoFrameBodyItem[]

Body for add video frames API

callback

ServiceCallback<void>

The callback

addVideoTranscript(string, string, msRest.HttpRequestBody, msRest.RequestOptionsBase)

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: msRest.HttpRequestBody, options?: msRest.RequestOptionsBase): Promise<RestResponse>

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

vTTfile

msRest.HttpRequestBody

Transcript file of the video.

options

msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addVideoTranscript(string, string, msRest.HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: msRest.HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

vTTfile

msRest.HttpRequestBody

Transcript file of the video.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

addVideoTranscript(string, string, msRest.HttpRequestBody, ServiceCallback<void>)

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: msRest.HttpRequestBody, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

vTTfile

msRest.HttpRequestBody

Transcript file of the video.

callback

ServiceCallback<void>

The callback

addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], msRest.RequestOptionsBase)

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], options?: msRest.RequestOptionsBase): Promise<RestResponse>

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

transcriptModerationBody

TranscriptModerationBodyItem[]

Body for add video transcript moderation result API

options

msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], RequestOptionsBase, ServiceCallback<void>)

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

transcriptModerationBody

TranscriptModerationBodyItem[]

Body for add video transcript moderation result API

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], ServiceCallback<void>)

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], callback: ServiceCallback<void>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

reviewId

string

Id of the review.

transcriptModerationBody

TranscriptModerationBodyItem[]

Body for add video transcript moderation result API

callback

ServiceCallback<void>

The callback

createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, Models.ReviewsCreateJobOptionalParams)

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression.

CallBack Schemas

Job Completion CallBack Sample

{
"JobId": ",
"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",
"WorkFlowId": "default",
"Status": "<This will be one of Complete, InProgress, Error>",
"ContentType": "Image",
"ContentId": "",
"CallBackType": "Job",
"Metadata": {
"adultscore": "0.xxx",
"a": "False",
"racyscore": "0.xxx",
"r": "True"
}
}

Review Completion CallBack Sample

{ "ReviewId": "",
"ModifiedOn": "2016-10-11T22:36:32.9934851Z",
"ModifiedBy": "",
"CallBackType": "Review",
"ContentId": "",
"Metadata": {
"adultscore": "0.xxx", "a": "False",
"racyscore": "0.xxx",
"r": "True"
},
"ReviewerResultTags": {
"a": "False",
"r": "True"
}
}

.

function createJob(teamName: string, contentType: Models.ContentType, contentId: string, workflowName: string, jobContentType: Models.JobContentType, content: Content, options?: Models.ReviewsCreateJobOptionalParams): Promise<Models.ReviewsCreateJobResponse>

Parameters

teamName

string

Your team name.

contentType

Models.ContentType

Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'

contentId

string

Id/Name to identify the content submitted.

workflowName

string

Workflow Name that you want to invoke.

jobContentType

Models.JobContentType

The content type. Possible values include: 'application/json', 'image/jpeg'

content

Content

Content to evaluate.

options

Models.ReviewsCreateJobOptionalParams

Returns

Promise<Models.ReviewsCreateJobResponse>

Promise<Models.ReviewsCreateJobResponse>

createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, ReviewsCreateJobOptionalParams, ServiceCallback<JobId>)

function createJob(teamName: string, contentType: Models.ContentType, contentId: string, workflowName: string, jobContentType: Models.JobContentType, content: Content, options: ReviewsCreateJobOptionalParams, callback: ServiceCallback<JobId>)

Parameters

teamName

string

Your team name.

contentType

Models.ContentType

Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'

contentId

string

Id/Name to identify the content submitted.

workflowName

string

Workflow Name that you want to invoke.

jobContentType

Models.JobContentType

The content type. Possible values include: 'application/json', 'image/jpeg'

content

Content

Content to evaluate.

options

ReviewsCreateJobOptionalParams

The optional parameters

callback

ServiceCallback<JobId>

The callback

createJob(string, Models.ContentType, string, string, Models.JobContentType, Content, ServiceCallback<JobId>)

function createJob(teamName: string, contentType: Models.ContentType, contentId: string, workflowName: string, jobContentType: Models.JobContentType, content: Content, callback: ServiceCallback<JobId>)

Parameters

teamName

string

Your team name.

contentType

Models.ContentType

Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'

contentId

string

Id/Name to identify the content submitted.

workflowName

string

Workflow Name that you want to invoke.

jobContentType

Models.JobContentType

The content type. Possible values include: 'application/json', 'image/jpeg'

content

Content

Content to evaluate.

callback

ServiceCallback<JobId>

The callback

createReviews(string, string, CreateReviewBodyItem[], Models.ReviewsCreateReviewsOptionalParams)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

.

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], options?: Models.ReviewsCreateReviewsOptionalParams): Promise<Models.ReviewsCreateReviewsResponse>

Parameters

urlContentType

string

The content type.

teamName

string

Your team name.

createReviewBody

CreateReviewBodyItem[]

Body for create reviews API

options

Models.ReviewsCreateReviewsOptionalParams

Returns

Promise<Models.ReviewsCreateReviewsResponse>

Promise<Models.ReviewsCreateReviewsResponse>

createReviews(string, string, CreateReviewBodyItem[], ReviewsCreateReviewsOptionalParams, ServiceCallback<string[]>)

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], options: ReviewsCreateReviewsOptionalParams, callback: ServiceCallback<string[]>)

Parameters

urlContentType

string

The content type.

teamName

string

Your team name.

createReviewBody

CreateReviewBodyItem[]

Body for create reviews API

options

ReviewsCreateReviewsOptionalParams

The optional parameters

callback

ServiceCallback<string[]>

The callback

createReviews(string, string, CreateReviewBodyItem[], ServiceCallback<string[]>)

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], callback: ServiceCallback<string[]>)

Parameters

urlContentType

string

The content type.

teamName

string

Your team name.

createReviewBody

CreateReviewBodyItem[]

Body for create reviews API

callback

ServiceCallback<string[]>

The callback

createVideoReviews(string, string, CreateVideoReviewsBodyItem[], Models.ReviewsCreateVideoReviewsOptionalParams)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

.

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], options?: Models.ReviewsCreateVideoReviewsOptionalParams): Promise<Models.ReviewsCreateVideoReviewsResponse>

Parameters

contentType

string

The content type.

teamName

string

Your team name.

createVideoReviewsBody

CreateVideoReviewsBodyItem[]

Body for create reviews API

options

Models.ReviewsCreateVideoReviewsOptionalParams

Returns

Promise<Models.ReviewsCreateVideoReviewsResponse>

Promise<Models.ReviewsCreateVideoReviewsResponse>

createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ReviewsCreateVideoReviewsOptionalParams, ServiceCallback<string[]>)

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], options: ReviewsCreateVideoReviewsOptionalParams, callback: ServiceCallback<string[]>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

createVideoReviewsBody

CreateVideoReviewsBodyItem[]

Body for create reviews API

options

ReviewsCreateVideoReviewsOptionalParams

The optional parameters

callback

ServiceCallback<string[]>

The callback

createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ServiceCallback<string[]>)

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], callback: ServiceCallback<string[]>)

Parameters

contentType

string

The content type.

teamName

string

Your team name.

createVideoReviewsBody

CreateVideoReviewsBodyItem[]

Body for create reviews API

callback

ServiceCallback<string[]>

The callback

getJobDetails(string, string, msRest.RequestOptionsBase)

Get the Job Details for a Job Id.

function getJobDetails(teamName: string, jobId: string, options?: msRest.RequestOptionsBase): Promise<Models.ReviewsGetJobDetailsResponse>

Parameters

teamName

string

Your Team Name.

jobId

string

Id of the job.

options

msRest.RequestOptionsBase

Returns

Promise<Models.ReviewsGetJobDetailsResponse>

Promise<Models.ReviewsGetJobDetailsResponse>

getJobDetails(string, string, RequestOptionsBase, ServiceCallback<Job>)

function getJobDetails(teamName: string, jobId: string, options: RequestOptionsBase, callback: ServiceCallback<Job>)

Parameters

teamName

string

Your Team Name.

jobId

string

Id of the job.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<Job>

The callback

getJobDetails(string, string, ServiceCallback<Job>)

function getJobDetails(teamName: string, jobId: string, callback: ServiceCallback<Job>)

Parameters

teamName

string

Your Team Name.

jobId

string

Id of the job.

callback

ServiceCallback<Job>

The callback

getReview(string, string, msRest.RequestOptionsBase)

Returns review details for the review Id passed.

function getReview(teamName: string, reviewId: string, options?: msRest.RequestOptionsBase): Promise<Models.ReviewsGetReviewResponse>

Parameters

teamName

string

Your Team Name.

reviewId

string

Id of the review.

options

msRest.RequestOptionsBase

Returns

Promise<Models.ReviewsGetReviewResponse>

Promise<Models.ReviewsGetReviewResponse>

getReview(string, string, RequestOptionsBase, ServiceCallback<Review>)

function getReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<Review>)

Parameters

teamName

string

Your Team Name.

reviewId

string

Id of the review.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<Review>

The callback

getReview(string, string, ServiceCallback<Review>)

function getReview(teamName: string, reviewId: string, callback: ServiceCallback<Review>)

Parameters

teamName

string

Your Team Name.

reviewId

string

Id of the review.

callback

ServiceCallback<Review>

The callback

getVideoFrames(string, string, Models.ReviewsGetVideoFramesOptionalParams)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

.

function getVideoFrames(teamName: string, reviewId: string, options?: Models.ReviewsGetVideoFramesOptionalParams): Promise<Models.ReviewsGetVideoFramesResponse>

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

Models.ReviewsGetVideoFramesOptionalParams

Returns

Promise<Models.ReviewsGetVideoFramesResponse>

Promise<Models.ReviewsGetVideoFramesResponse>

getVideoFrames(string, string, ReviewsGetVideoFramesOptionalParams, ServiceCallback<Frames>)

function getVideoFrames(teamName: string, reviewId: string, options: ReviewsGetVideoFramesOptionalParams, callback: ServiceCallback<Frames>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

ReviewsGetVideoFramesOptionalParams

The optional parameters

callback

ServiceCallback<Frames>

The callback

getVideoFrames(string, string, ServiceCallback<Frames>)

function getVideoFrames(teamName: string, reviewId: string, callback: ServiceCallback<Frames>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

callback

ServiceCallback<Frames>

The callback

publishVideoReview(string, string, msRest.RequestOptionsBase)

Publish video review to make it available for review.

function publishVideoReview(teamName: string, reviewId: string, options?: msRest.RequestOptionsBase): Promise<RestResponse>

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

publishVideoReview(string, string, RequestOptionsBase, ServiceCallback<void>)

function publishVideoReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

publishVideoReview(string, string, ServiceCallback<void>)

function publishVideoReview(teamName: string, reviewId: string, callback: ServiceCallback<void>)

Parameters

teamName

string

Your team name.

reviewId

string

Id of the review.

callback

ServiceCallback<void>

The callback