WorkDocs / Client / exceptions / DocumentLockedForCommentsException

DocumentLockedForCommentsException

class WorkDocs.Client.exceptions.DocumentLockedForCommentsException

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

Example

try:
  ...
except client.exceptions.DocumentLockedForCommentsException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) –

  This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

  • Message (string) –

  • Error (dict) – Normalized access to common exception attributes.

    • Code (string) – An identifier specifying the exception type.

    • Message (string) – A descriptive message explaining why the exception occured.