Class ApprovalProcess<S>

constructor

• new ApprovalProcess<S extends Schema>(conn: Connection<S>): ApprovalProcess<S>

  Type Parameters

  • S extends Schema

  Parameters

  • conn: Connection<S>

  Returns ApprovalProcess<S>

_conn

approve

• approve(
      workitemId: string,
      comments?: string,
      options?: ApprovalProcessActionOptions,
  ): ApprovalProcessRequest<S>

  Approve approval request for an item

  Parameters

  • workitemId: string
  • Optionalcomments: string
  • options: ApprovalProcessActionOptions = {}

  Returns ApprovalProcessRequest<S>

list

• list(): Promise<{ [index: string]: ApprovalProcessDefinition }>

  Get all approval process definitions registered to sobjects

  Returns Promise<{ [index: string]: ApprovalProcessDefinition }>

reject

• reject(
      workitemId: string,
      comments?: string,
      options?: ApprovalProcessActionOptions,
  ): ApprovalProcessRequest<S>

  Reject approval request for an item

  Parameters

  • workitemId: string
  • Optionalcomments: string
  • options: ApprovalProcessActionOptions = {}

  Returns ApprovalProcessRequest<S>

request

• request(
      requests: (ApprovalProcessRequestConfig | ApprovalProcessRequest<S>)[],
  ): StreamPromise<ApprovalProcessRequestResult[]>

  Send bulk requests for approval process

  Parameters

  • requests: (ApprovalProcessRequestConfig | ApprovalProcessRequest<S>)[]

  Returns StreamPromise<ApprovalProcessRequestResult[]>

submit

• submit(
      contextId: string,
      comments?: string,
      options?: ApprovalProcessActionOptions,
  ): ApprovalProcessRequest<S>

  Submit approval request for an item

  Parameters

  • contextId: string
  • Optionalcomments: string
  • Optionaloptions: ApprovalProcessActionOptions

  Returns ApprovalProcessRequest<S>