Microsoft Information Protection (MIP) SDK for C: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C
Loading...
Searching...
No Matches
mip_cc_document_state Struct Reference

Represents the current state of a label-aware document. More...

#include <src/api/mip_cc/upe/document_state_cc.h>

+ Collaboration diagram for mip_cc_document_state:

Data Fields

mip_cc_dictionary auditMetadata
 Optional application-specific metadata that is used when sending audit reports Recognized values: 'Sender': Sender email address 'Recipients': JSON array of email recipients 'LastModifiedBy': Email address of the user who last modified a document 'LastModifiedDate': Date a document was last modified.
 
mip_cc_content_format contentFormat
 Format of document (file vs.
 
const char * contentId
 Human-readable document description visible in tenant audit portal Example for a file: [path\filename] Example for an email: [Subject:Sender].
 
mip_cc_metadata_callback contentMetadataCallback
 Document metadata callback.
 
uint32_t contentMetadataVersion
 Document metadata version, default should be 0.
 
mip_cc_metadata_version_format contentMetadataVersionFormat
 Describes how metadata versioning is processed.
 
mip_cc_data_state dataState
 State of document data as application interacts with it.
 
mip_cc_protection_descriptor protectionDescriptor
 Protection descriptor if document is currently protected, else null.
 

Detailed Description

Represents the current state of a label-aware document.

Definition at line 72 of file document_state_cc.h.

Field Documentation

◆ auditMetadata

mip_cc_dictionary mip_cc_document_state::auditMetadata

Optional application-specific metadata that is used when sending audit reports Recognized values: 'Sender': Sender email address 'Recipients': JSON array of email recipients 'LastModifiedBy': Email address of the user who last modified a document 'LastModifiedDate': Date a document was last modified.

Definition at line 108 of file document_state_cc.h.

◆ contentFormat

mip_cc_content_format mip_cc_document_state::contentFormat

Format of document (file vs.

email)

Definition at line 98 of file document_state_cc.h.

◆ contentId

const char* mip_cc_document_state::contentId

Human-readable document description visible in tenant audit portal Example for a file: [path\filename] Example for an email: [Subject:Sender].

Definition at line 78 of file document_state_cc.h.

◆ contentMetadataCallback

mip_cc_metadata_callback mip_cc_document_state::contentMetadataCallback

Document metadata callback.

Definition at line 88 of file document_state_cc.h.

◆ contentMetadataVersion

uint32_t mip_cc_document_state::contentMetadataVersion

Document metadata version, default should be 0.

Definition at line 113 of file document_state_cc.h.

◆ contentMetadataVersionFormat

mip_cc_metadata_version_format mip_cc_document_state::contentMetadataVersionFormat

Describes how metadata versioning is processed.

Definition at line 118 of file document_state_cc.h.

◆ dataState

mip_cc_data_state mip_cc_document_state::dataState

State of document data as application interacts with it.

Definition at line 83 of file document_state_cc.h.

◆ protectionDescriptor

mip_cc_protection_descriptor mip_cc_document_state::protectionDescriptor

Protection descriptor if document is currently protected, else null.

Definition at line 93 of file document_state_cc.h.


The documentation for this struct was generated from the following file: