Bool checkdynamicplaylistusagebyname(string name), Createdynamicplaylist() – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 52

Advertising
background image

40

Required Permissions
Dynamic Playlist: View Dynamic Playlists

Parameters

[int] dynamicPlaylistId: The identifier and primary key of the ImageVideoDynamicPlaylist or
AudioDynamicPlaylist instance to be evaluated. If an instance with the specified identifier does not exist, the
method will return False without error.

bool CheckDynamicPlaylistUsageByName(string name)

Description
Determines if the

ImageVideoDynamicPlaylist

or

AudioDynamicPlaylist

instance (specified with its alternate, user-

defined key) is referenced by one or more presentations. If the specified instance has parent dependencies (i.e. it is in
use), this method will return True. Otherwise, it will return False.

Note that when using this method to check whether an instance can be deleted, a False (“not in use”) status may
change in the time between calling this method and calling

DeleteDynamicPlaylist()

.

Required Permissions
Dynamic Playlist: View Dynamic Playlists

Parameters

[string] name: The user-defined name (i.e. the alternate key) of the Dynamic Playlist to be evaluated. If an
instance with the specified identifier does not exist, the method will return False without error.

DynamicPlaylist CreateDynamicPlaylist(DynamicPlaylist entity)

Description
Creates a new

ImageVideoDynamicPlaylist

or

AudioDynamicPlaylist

instance and a related MRSS file with the

specified name and

Content

entities. This method returns the newly created object with all initialized properties if

successful. If object creation is unsuccessful, this method will return a Null value.

Advertising