TABLE OF CONTENTS

 

Available input properties for Widgets

 

Key : search-criteria - Object

 

Object properties

Possible values

Explanation

Example

mashupFormats: string[]

Audio

It will search all the mashups of audio format of the portal

-


Video

It will search all the mashups of video format of the portal

-


Collection

It will search all the mashups of collection format of the portal

-


Document

It will search all the mashups of document format of the portal 

-


Image

It will search all the mashups of image format of the portal 

-


Playlist

It will search all the mashups of playlist format of the portal 

-


Quiz

It will search all the mashups of Quiz format of the portal 

-


Survey

It will search all the mashups of survey format of the portal 

-


Live

It will search all the live streamed videos of the portal 

-

orderBy: string

Title 

It will order searched mashups according to mashups title in alphabetical order

-


Author

It will order searched mashups according to different author names in alphabetical order

-


Popularity

It will order searched mashups according to popularity i.e., most views, comments, likes etc. 

-


Weight

Weight is used to order featured mashups based on their weight (order).

-


TotalLikes

It will order searched mashups according to most likes on mashups

-


TotalViewed

It will order searched mashups according to the greatest number of views on mashups

-


TotalFavourite

It will order searched mashups according to greatest number of favorites on mashups

-


TotalComments

It will order searched mashups according to the greatest number of comments on mashups

-


CreatedDate

It will order searched mashups according to its created dates

-


AvailableDate

It will order searched mashups according to the date mashups are available from

-


UpdatedDate

It will order searched mashups according to the most recent entry

-


ExpiryDate

It will order searched mashups according to the date mashups are expired from

-

sortType: string

ASC 

It will sort searched mashups in ascending order 

-


DESC 

It will sort searched mashups in descending order 

-

keyword: string

-

It will search mashups against the mentioned keyword

"Any"

tags: string[] 

-

An array of tags that will search mashup accordingly 

["asd", "asdsa"]

customAttributes: string 

-

It will search for mashups against mentioned custom attribute 

"New:This is New"

authorName: string 

-

It will search for all the mashups that belong to the mentioned author 

"Bill"

pageIndex: number 

-

It will set page to a specific index against the searched mashups list, page index starts from 0

0

pageSize: number 

-

It will set the page size for the searched mashups list

18

categoryId: number 

-

It will search mashups against the mentioned category id

12390

mashupIds: number[] 

-

It will search all the mashups against the mentioned mashup ids

[174548, 173319]

tenantId: number 

-

It will search mashups against a specific tenant 

8402

userProfileId: number 

-

It will search mashups against a specific user

0

authorUserProfileId: number 

-

It will search mashups against a specific author User


forcedRefresh: boolean

-

It will force refresh the search criteria

FALSE

isFeatured: boolean 

-

It will search all the featured mashups of the portal 

TRUE

isGlobal: boolean 

-

It will search among all the mashups of the portal

TRUE

showOnChannelLibrary: boolean

-

It will search all the mashups visible on channel library of the portal

FALSE

isTranscriptionEnabled: boolean

-

It will search all the mashups which have transcription enabled

FALSE

isClipping: boolean 

-

It will search all the clipped mashups of the portal

FALSE

IsDeleted: boolean 

-

It will search all the deleted mashups of the portal

TRUE

isFlagged: boolean

-

It will search all the flagged mashups in case of DEM

FALSE

isRedaction: boolean

-

It will search all the redacted mashups

TRUE

isFaceDetection: boolean

-

It will search all the mashups in which face have been detected

FALSE

timedDataTypes: string[]

Annotation

It will bring the mashups which contain annotations in them

["Annotation"]

availableFrom: date

-

It will search mashups that are available from the mentioned date

-

availableTo: date

-

It will search mashups that are available to the mentioned date

-

 

Key : order-by - String

 

Object properties

Possible values

Explanation

Example

-

Title 

It will order searched mashups according to mashups title in alphabetical order

-


Author

It will order searched mashups according to different author names in alphabetical order

-


Popularity

It will order searched mashups according to popularity i.e., most views, comments, likes etc. 

-


Weight

Weight is used to order featured mashups based on their weight (order).

-


TotalLikes

It will order searched mashups according to most likes on mashups

-


TotalViewed

It will order searched mashups according to the greatest number of views on mashups

-


TotalFavourite

It will order searched mashups according to greatest number of favorites on mashups

-


TotalComments

It will order searched mashups according to the greatest number of comments on mashups

-


CreatedDate

It will order searched mashups according to its created dates

-


AvailableDate

It will order searched mashups according to the date mashups are available from

-


UpdatedDate

It will order searched mashups according to the most recent entry

-


ExpiryDate

It will order searched mashups according to the date mashups are expired from

-

 

Key: sort-type - String

 

Object properties

Possible values

Explanation

Example

-

ASC 

It will sort searched mashups in ascending order 

-


DESC 

It will sort searched mashups in descending order 

-

 

 

Key: keyword - String

 

Object properties

Possible values

Explanation

Example

-

-

It will search mashups against the mentioned keyword

"Any"

 

 

Key: page-index - Number

 

Object properties

Possible values

Explanation

Example

-

-

It will set page to a specific index against the searched mashups list, page index starts from 0

0

 

 

Key: page-size - Number

 

Object properties

Possible values

Explanation

Example

-

-

It will set the page size for the searched mashups list 

18

 

 

Key: is-featured - Boolean

 

Object properties

Possible values

Explanation

Example

-

-

It will search all the featured mashups of the portal

TRUE

 

 

Key: is-global - Boolean

 

Object properties

Possible values

Explanation

Example

-

-

It will search among all the mashups of the portal

TRUE

 

 

Key: show-onchannel-library - Boolean

 

Object properties

Possible values

Explanation

Example

-

-

It will search all the mashups visible on channel library of the portal

TRUE

 


Note: pageIndex and pageSize are only applicable with detail view and gallery view widget.


Note: order-by, sort-type, keyword, page-index, page-size, is-featured, is-global, and show-on-channel-library can be passed in as separate input property or in the search-criteria as an object.