PySubscription

class PySubscription(subscription)

Bases: Generic[TSchedule], PyWithSchedule[TSchedule], PyWithOwner

Interface for a subscription.

• Parameters: subscription (ISubscription [ ])

__init__(subscription)

Creates a new PySubscription object.

Args: : subscription: A ISubscription object.

Returns: None.

• Parameters: subscription (ISubscription [ ])
• Return type: None

Methods

__init__(subscription)	Creates a new PySubscription object.

Attributes

attach_image	Gets or sets whether or not an image file should be attached to the notification.
attach_pdf	Gets or sets whether or not a pdf file should be attached to the notification.
content	Gets or set the content reference of the subscription.
content_url	Get the site-unique "content URL" of the content item, or an empty string if the content type does not use a content URL.
id	Gets the unique identifier.
location	Gets the logical location path of the content item, for project-level content this is the project path and the content item name.
message	Gets or sets the message of the subscription.
name	Gets the name of the content item.
owner	Gets or sets the owner for the content item.
page_orientation	Gets or set the page orientation of the subscription.
page_size_option	Gets or set the page page size option of the subscription.
schedule	Gets the content item's schedule.
subject	Gets or sets the subject of the subscription.
suspended	Gets or sets whether or not the subscription is suspended.

property subject : str

Gets or sets the subject of the subscription.

property attach_image : bool

Gets or sets whether or not an image file should be attached to the notification.

property attach_pdf : bool

Gets or sets whether or not a pdf file should be attached to the notification.

property page_orientation : str

Gets or set the page orientation of the subscription.

property content_url : str

Get the site-unique “content URL” of the content item, or an empty string if the content type does not use a content URL.

property id : UUID

Gets the unique identifier.

property location : PyContentLocation

Gets the logical location path of the content item, for project-level content this is the project path and the content item name.

property name : str

Gets the name of the content item. This is equivalent to the last segment of the Location. Renames should be performed through mapping.

property owner : PyContentReference

Gets or sets the owner for the content item.

property page_size_option : str

Gets or set the page page size option of the subscription.

property schedule : TSchedule

Gets the content item’s schedule.

property suspended : bool

Gets or sets whether or not the subscription is suspended.

property message : str

Gets or sets the message of the subscription.

property content : PySubscriptionContent

Gets or set the content reference of the subscription.