clearNotifications(objectPath)

Use this method to clear the object's alert list.

This method returns no bibus » asynchDetail objects in the bibus » asynchReply » details property.

This method may return the following values in the bibus » asynchReply » status property:

You may make secondary requests after using this method, depending on the server response. For more information about the asynchronous conversation status and secondary requests in asynchronous conversations, see Secondary requests.

Use of this method requires:

  • write permission for the object

  • traverse permission for all ancestors of the object

Signatures

Java and Apache Axis
 
public  com.cognos.developer.schemas.bibus._3.AsynchReply 
clearNotifications( 
com.cognos.developer.schemas.bibus._3.SearchPathSingleObject 
objectPath) 
C# .NET
 
public  asynchReply  clearNotifications(searchPathSingleObject 
objectPath) 
Example: Using the clearNotifications(objectPath) Method with the Delivery Service in Java

The following Java code snippet demonstrates how to use the delivery » clearNotifications(objectPath) method with the delivery service.

To see this code in context, view the Java sample Alerts/ManageAlerts.java. For more information about the samples, see Code samples and language-specific coding practices.

 
asynchReply  =  connection.getDeliveryService().clearNotifications( 
		new  SearchPathSingleObject(reportPath)); 
 

References

Part of the following method sets:
Implemented by the following services:

The services that implement the clearNotifications method, along with the associated SOAP actions, are listed in the following table.

Table 1. Services implementing the clearNotifications method.

Service

SOAP Action
deliveryService

http://www.ibm.com/xmlns/prod/cognos/deliveryService/201404/

What's new

New in Version 8.3 — Report Email Alerts

This method can now be used with bibus » baseReport objects.

Input parameters

Use the following parameters when calling this method.

objectPath

Specifies the object associated with the request.

This argument

Return values

This method returns the following values.

result

Returns the state of the asynchronous conversation. Possible asynchronous conversation states are defined in the bibus » asynchReplyStatusEnum enumeration set.

Any data requested can be obtained by examining the bibus » asynchReply » details property.

This result