Options
All
  • Public
  • Public/Protected
  • All
Menu

ViewsheetAction describes an action that opens a viewsheet and performs one or more sub-actions on it. ViewsheetAction has a value of 'viewsheet' for the actionType property.

Hierarchy

  • ViewsheetAction

Index

Properties

Optional bookmarkName

bookmarkName: undefined | string

The name of the bookmark, if any, to open the viewsheet to.

Optional bookmarkType

bookmarkType: undefined | string

The type of bookmark. The allowable values are 'private', 'all_share', and 'group_share'.

Optional bookmarkUser

bookmarkUser: undefined | string

THe name of the user that owns the bookmark.

Optional emails

emails: string[]

The email address to which the viewsheet should be sent.

Optional format

format: undefined | string

The format in which the viewsheet should be sent in the delivery emails. The allowable values are 'EXCEL', 'PDF', an 'POWERPOINT'.

Optional htmlMessage

htmlMessage: undefined | false | true

A flag indicating if the message body is formatted as HTML.

Optional message

message: undefined | string

The message body of the delivery and/or notification emails.

Optional notifies

notifies: string[]

The email addresses to which a notification email should be sent that the action has been performed.

Optional sender

sender: undefined | string

The email address from which the delivery and/or notification emails are sent.

Optional subject

subject: undefined | string

The subject of the delivery and/or notification emails.

viewsheet

viewsheet: string

The asset identifier of the viewsheet.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc