Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Permission

A date and region-bounded distribution permissions; maps to permission_type

Hierarchy

  • Permission

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor for Permission objects. Takes all of the attributes as an object.

    Parameters

    • permission: Partial<Permission>

      An object containing all fields for the Permission.

    Returns Permission

Properties

Optional countryCode

countryCode: string[] = []

A 2-character ISO country code indicating the regions where this applies. Use the CountryCode enum for an easy, validated option; maps to country_code

enabled

enabled: boolean = true

Boolean flag defining whether the permissions is granted or not; maps to enabled

Optional endDate

endDate: Date

The end of the date range for which this permissions applies. Provide a Date object; maps to end_date

Optional startDate

startDate: Date

The start of the date range for which this permissions applies. Provide a Date object; maps to start_date

type

type: string = ''

The permissions type. See AudioSalad documentation for possible types; maps to type

Methods

xml

  • xml(): string
  • Generates AudioSalad XML for the permissions.

    Returns string

    AudioSalad XML <permissions> element

Generated using TypeDoc