Tagged Playlists Entity (2022/06)

1 min

all tagged playlist entities are structured as follows entity id \int\ \read only\ a unique identifier for the tagged playlist instance this value is generated by the server when the tagged playlist is created name \string\ \read write\ the name of the tagged playlist the maximum length of this string is 50 characters physicalpath \string\ \read only\ the location of the file in the server directory contentsvirtualpath \string\ \read write\ the virtual directory location of files in the tagged playlist tagged playlists can only use files contained in this directory rule \string\ \read write\ a set of tagging conditions that determines tagged media to include in the playlist ttl \timespan\ \read write\ the frequency with which players will query bsn cloud servers to determine if there is any new tagged media to include/exclude in the tagged playlist (ttl is an acronym for time to live) see timespan docid\ dx1c8usfkxpwntprb9f t for more information about this data type waitingforapprove \bool\ \read write\ a flag that determines whether recent changes to media tags have been approved for the tagged playlist by default, changing media tags will not automatically add or remove media from a tagged playlist a user with the "update tagged playlist" permission (administrators, creators, general managers) will need to set this flag to false for changes to go into effect creationdate \datetime\ \read only\ a timestamp indicating when the tagged playlist was created on bsn cloud see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate \datetime\ \read only\ a timestamp indicating when the tagged playlist was last modified on bsn cloud see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type content \taggedplaylistcontent\[]\ \read write\ an array of content object instances representing content files in the tagged playlist contentid \int\ \read write\ the unique identifier for the tagged playlist content filename \string\ \read write\ the filename of the tagged playlist content displayduration \nullable\<timespan\>\ \read write\ the amount of time the content will be displayed before transitioning to the next entry (the default is six seconds) see timespan docid\ dx1c8usfkxpwntprb9f t for more information about this data type validitystartdate \nullable\<datetime\>\ \read write\ the validity start date for the entry (that is, the point at which it will start being included in the tagged playlist) a null value specifies that the item is valid immediately when added to the tagged playlist see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type validityenddate \nullable\<datetime\>\ \read write\ the validity end date for the associated entry (that is, the point at which it will no longer be included in the tagged playlist) a null value specifies that the item will be valid until it is removed from the tagged playlist manually see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type state \taggedplaylistcontentstate\ \read write\ the content state enumeration has three possible values "approved", "pending addition", and "pending deletion" presentations \presentationinfo\[]\ \read only\ an array of presentation info docid\ rh tklzoo3rpbid0mdc9v entities for each presentation associated with the tagged playlist instance permissions \permission\[]\ \read write\ a list of permission object instances representing permissions rules assigned to the tagged playlist