cancelScheduleInSession() Method
In ScheduleService, use the cancelScheduleInSession() method to cancel the schedule associated with the bipSessionToken string for a given user.
For more information about in-session methods, see About In-Session Methods.
Signature
String cancelScheduleInSession(String jobInstanceID, String bipSessionToken);
Parameters for cancelScheduleInSession() Method
Parameter | Description |
---|---|
String jobInstanceID |
The ID assigned to the instance of the job that generated the output. The jobInstanceID is a string of integers. |
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. |