scheduleReportInSession() Method

In ScheduleService, use the scheduleReportInSession() method to schedule a report based on the schedule request, delivery channel, and bipSessionToken of a given user.

For more information about in-session methods, see About In-Session Methods.

Signature

String scheduleReportInSession(ScheduleRequest scheduleRequest, DeliveryChannel deliveryChannel, String bipSessionToken);

Parameters for scheduleReportInSession() Method

Parameter Description

ScheduleRequest scheduleRequest

Specifies a ScheduleRequest object for the report that you want to run. See ScheduleRequest..

DeliveryChannel deliveryChannel

Specifies the delivery channels through which the report will be delivered. See DeliveryChannels.

String bipSessionToken

The proprietary token string generated for the user. With the bipSessionToken string, the user no longer needs to provide user credentials. The server can validate this token string and restore the session to perform needed operation.