InvalidUserTokenException Property

Summary

Custom error to be thrown when the user tries to access a document with an invalid user token.

Syntax

C++/CLI

Python

public static Exception InvalidUserTokenException { get; set; }

public:  
   static property Exception^ InvalidUserTokenException 
   { 
      Exception^ get() 
      void set(Exception^ value) 
   }

InvalidUserTokenException # get and set (DocumentFactory)

Property Value

The custom error to be thrown when the user tries to access a document with an invalid user token. The default value is null.

Remarks

The Document Library supports optional user tokens that can be assigned to a document to restrict access in the cache.

The InvalidUserTokenException property controls what occurs when the program tries to load or delete such a document with an invalid user token.

When the value of InvalidUserTokenException is null (the default value), then the load or delete method will simply fail. For instance, the LoadFromUri and LoadFromCache methods will return null and the DeleteFromCache will return false as if the document does not exist in the cache.

To modify this behavior and throw an exception instead, set any Exception derived class instance object in InvalidUserTokenException, and the DocumentFactory will throw this exception when the user tries to load or delete the document.

Requirements

Target Platforms