Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

All live text feed entities are structured as follows:

entity:

  • Id int read-only: The unique identifier for the live text feed instance

  • Name string read-write: The name of the live text feed instance. The maximum length of this string is 50 characters.

  • PhysicalPath string read-onlyThe location of the live text feed XML file in the server directory

  • FileSize long read-onlyThe size of the live text feed XML file (in bytes)

  • FileHash string read-onlyThe hash value of the live text feed file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

  • CreationDate DateTime read-onlyA timestamp indicating when the live text feed was created on BSN.cloud. See DateTime for more information about this data type.

  • LastModifiedDate DateTime read-only: A timestamp indicating when the live text feed was last modified on BSN.cloud. See DateTime for more information about this data type.

  • Items LiveTextFeedItem[] read-write

    • Title string read-writeThe key (RSS item title) of the item in the associated live text feed

    • Description string read-writeThe value (RSS item description) of the item in the associated live text feed

    • ValidityStartDate Nullable<DateTime> read-writeThe validity start date for the entry (that is, the point at which it will start being included in the live text feed).A null value specifies that the item is valid immediately when added to the live text feed. See DateTime for more information about this data type.

    • ValidityEndDate Nullable<DateTime> read-writeThe validity end date for the associated entry (that is, the point at which it will no longer be included in the live text feed).  A null value specifies that the item will be valid until it is removed from the live text feed manually by a user. See DateTime for more information about this data type.

  • Presentations PresentationInfo[] read-onlyAn array of Presentation Info entities for each presentation associated with the live text feed instance

  • Permissions Permission[] read-write: A list of permission object instances representing permissions rules assigned to the live text feeds instance

...