Interface ISharingSettings

interface ISharingSettings {
    enable-report-subscription: boolean;
    enable-reporting-template-subscription: boolean;
    enable-sharing: boolean;
    maxRecipients: number;
    maxSubscriptionRecipients: number;
    reportSubscriptionStatus: string;
    reportSubscriptionStatusChangeTime: string;
    reporting-service-license-status: "disabled" | "enabled";
    reportingTemplateSubscriptionStatus: "none" | "enabling" | "disabling";
    reportingTemplateSubscriptionStatusChangeTime: string;
    tenantId: string;
}

Properties

enable-report-subscription enable-reporting-template-subscription enable-sharing maxRecipients maxSubscriptionRecipients reportSubscriptionStatus reportSubscriptionStatusChangeTime reporting-service-license-status reportingTemplateSubscriptionStatus reportingTemplateSubscriptionStatusChangeTime tenantId

Properties

enable-report-subscription

enable-report-subscription: boolean

true if report-subscription feature is enabled for this tenant

enable-reporting-template-subscription

enable-reporting-template-subscription: boolean

true if reporting-template-subscription feature is enabled for this tenant

enable-sharing

enable-sharing: boolean

Whether API endpoints for sharing are enabled

maxRecipients

maxRecipients: number

Maximum number of recipients when creating a sharing task

maxSubscriptionRecipients

maxSubscriptionRecipients: number

Max Recipients accepted when creating a new subscription (excluding the owner)

reportSubscriptionStatus

reportSubscriptionStatus: string

This indicates that there is an ongoing operation to either disable or enable the report subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature

reportSubscriptionStatusChangeTime

reportSubscriptionStatusChangeTime: string

UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record.

reporting-service-license-status

reporting-service-license-status: "disabled" | "enabled"

Whether the license for the tenant has the reportingService feature enabled.

reportingTemplateSubscriptionStatus

reportingTemplateSubscriptionStatus: "none" | "enabling" | "disabling"

This indicates that there is an ongoing operation to either disable or enable the reporting template subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature

reportingTemplateSubscriptionStatusChangeTime

reportingTemplateSubscriptionStatusChangeTime: string

UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record

tenantId

tenantId: string

These persisted sharing settings are only available for this tenant. Extracted from request JWT.

Settings

Member Visibility

Theme

On This Page