Estructuras

mip_cc_application_info

Un struct que incluye información específica de la aplicación

Campo Descripción
applicationId Identificador de aplicación establecido en el portal de AAD (debe ser un GUID sin corchetes).
applicationName Nombre de la aplicación(Solo debe contener caracteres ASCII válidos excluyendo ';')
applicationVersion La versión de la aplicación que se usa (solo debe contener caracteres ASCII válidos excluidos ';')
typedef struct {
  const char* applicationId;      
  const char* applicationName;    
  const char* applicationVersion; 
} mip_cc_application_info;

mip_cc_oauth2_challenge

Información proporcionada por un servidor para generar un token de OAuth2

Campo Descripción
autoridad Autoridad de OAuth2
recurso Recurso de OAuth2
ámbito Ámbito de OAuth2
typedef struct {
  const char* authority; 
  const char* resource;  
  const char* scope;     
} mip_cc_oauth2_challenge;

mip_cc_handle

Controlador opaco para objeto MIP

Campo Descripción
typeId Número mágico que identifica de forma única el tipo de controlador específico
datos Datos de controlador sin procesar
typedef struct {
  uint32_t typeId; 
  void* data;      
} mip_cc_handle;

mip_cc_guid

GUID

typedef struct {
  char guid[37];
} mip_cc_guid;

mip_cc_kv_pair

Pareja clave/valor

Campo Descripción
clave Clave
valor Valor
typedef struct {
  const char* key;   
  const char* value; 
} mip_cc_kv_pair;

mip_cc_error

Información de error

typedef struct {
  mip_cc_result result;
  char description[ERROR_STRING_BUFFER_SIZE];

  // MIP_RESULT_ERROR_NETWORK details
  mip_cc_network_error_category networkError_Category;
  int32_t networkError_ResponseCode;

  // MIP_RESULT_ERROR_NO_PERMISSIONS details
  char noPermissionsError_Owner[ERROR_STRING_BUFFER_SIZE];
  char noPermissionsError_Referrer[ERROR_STRING_BUFFER_SIZE];

  // MIP_RESULT_ERROR_SERVICE_DISABLED details
  mip_cc_service_disabled_error_extent serviceDisabledError_Extent;
} mip_cc_error;

mip_cc_http_header

Encabezado de solicitud/respuesta HTTP

Campo Descripción
nombre Nombre o clave de encabezado
valor Valor de encabezado
typedef struct {
  const char* name;  
  const char* value; 
} mip_cc_http_header;

mip_cc_http_request

Solicitud HTTP

Campo Descripción
id Id. de solicitud único: correlacionado con la misma propiedad en mip_cc_http_response
tipo Tipo de solicitud HTTP (por ejemplo, OBTENER frente a POST)
url DIRECCIÓN URL de solicitud HTTP
bodySize Tamaño del cuerpo de la solicitud HTTP en bytes
cuerpo Cuerpo de solicitud HTTP con contenido de búfer
headersCount Número de encabezados de solicitud HTTP
encabezados Búfer que contiene encabezados de solicitud HTTP
typedef struct {
  const char* id;                    
  mip_cc_http_request_type type;     
  const char* url;                   
  int64_t bodySize;                  
  const uint8_t* body;               
  int64_t headersCount;              
  const mip_cc_http_header* headers; 
} mip_cc_http_request;

mip_cc_http_response

Respuesta HTTP

Campo Descripción
id Id. de solicitud único: correlacionado con la misma propiedad en mip_cc_http_request
statusCode Código de estado de respuesta HTTP
bodySize Tamaño del cuerpo de respuesta HTTP en bytes
cuerpo Cuerpo de respuesta HTTP que contiene búfer
headersCount Número de encabezados de respuesta HTTP
encabezados Búfer que contiene encabezados de respuesta HTTP
typedef struct {
  const char* id;                    
  int32_t statusCode;                
  int64_t bodySize;                  
  const uint8_t* body;               
  int64_t headersCount;              
  const mip_cc_http_header* headers; 
} mip_cc_http_response;

mip_cc_identity

Un struct que contiene información de identificación de usuario

Campo Descripción
Correo electrónico Dirección de correo electrónico del usuario
nombre Nombre descriptivo de usuario, que se usa para el marcado de contenido.
typedef struct {
  const char* email;          
  const char* name;           
} mip_cc_identity;

mip_cc_feature_override

Define el estado habilitado o deshabilitado de una sola característica

Campo Descripción
característica Nombre de la característica
valor Estado habilitado o deshabilitado
typedef struct {
  mip_cc_flighting_feature feature; 
  bool value;                       
} mip_cc_feature_override;

mip_cc_user_rights

Un grupo de usuarios y los derechos asociados a ellos

Campo Descripción
usuarios Lista de usuarios
usersCount Número de usuarios
derechos Lista de derechos
rightsCount Número de derechos
typedef struct {
  const char** users;  
  int64_t usersCount;  
  const char** rights; 
  int64_t rightsCount; 
} mip_cc_user_rights;

mip_cc_user_roles

Un grupo de usuarios y los roles asociados con ellos

Campo Descripción
usuarios Lista de usuarios
usersCount Número de usuarios
roles Lista de roles
rolesCount Número de roles
typedef struct {
  const char** users;  
  int64_t usersCount;  
  const char** roles; 
  int64_t rolesCount; 
} mip_cc_user_roles;

mip_cc_async_task

Define una única solicitud de envío de tareas asincrónicas

Campo Descripción
id Id. de tarea
delayMs Retraso hasta la ejecución de la tarea (en milisegundos)
executeOnIndependentThread Si esta tarea debe ejecutarse en un hilo completamente independiente o puede volver a usar una conversación compartida
typedef struct {
  const char* id;                   
  int64_t delayMs;                  
  bool executeOnIndependentThread;  
} mip_cc_async_task;

mip_cc_application_action_state

Representa el estado actual de la aplicación mientras realiza una operación relacionada con etiquetas

Campo Descripción
actionState Describe si/cómo una aplicación intenta cambiar el estado de etiqueta.
newLabel Si 'actionType' es 'UPDATE': Nueva etiqueta.
newLabelExtendedProperties Si 'actionType' es 'UPDATE': propiedades adicionales que se escribirán en metadatos.
newLabelAssignmentMethod Si 'actionType' es 'UPDATE': el método de asignación de la nueva etiqueta.
isDowngradeJustified Si 'actionType' es 'UPDATE': si el usuario ha justificado o no una degradación de etiqueta.
downgradeJustification Si "actionType" es "UPDATE": Texto de justificación de degradación de etiqueta proporcionado por el usuario.
supportedActions Máscara de enumeración que describe las acciones relacionadas con etiquetas que una aplicación puede realizar.
typedef struct {
  mip_cc_label_action_state actionState;                    
  mip_cc_label newLabel;                                    
  mip_cc_dictionary newLabelExtendedProperties;             
  mip_cc_label_assignment_method newLabelAssignmentMethod;  
  bool isDowngradeJustified;                                
  const char* downgradeJustification;                       
  mip_cc_label_action_type supportedActions;                
} mip_cc_application_action_state;

mip_cc_document_state

Definición de función de devolución de llamada para recuperar metatdatas del documento, filtrada por nombre o prefijo.

Campo Descripción
dataState Estado de los datos del documento a medida que la aplicación interactúa con ellos.
contentMetadataCallback Devolución de llamada de metadatos del documento.
protectionDescriptor Descriptor de protección si el documento está protegido actualmente, de lo contrario, es nulo.
contentFormat Formato del documento (archivo frente a correo electrónico).
auditMetadata Metadatos opcionales específicos de la aplicación que se usan al enviar informes de auditoría. Valores reconocidos: 'Remitente': Dirección de correo electrónico del remitente; 'Destinatarios': matriz JSON de destinatarios de correo electrónico; 'LastModifiedBy': dirección de correo electrónico del usuario que modificó por última vez un documento; 'LastModifiedDate': fecha en la que se modificó por última vez un documento
contentMetadataVersion Versión de metadatos del documento, el valor predeterminado debe ser 0.
contentMetadataVersionFormat Describe cómo se procesa el control de versiones de metadatos.
typedef struct {

  const char* contentId;


  mip_cc_data_state dataState;

  mip_cc_metadata_callback contentMetadataCallback;

  mip_cc_protection_descriptor protectionDescriptor;

  mip_cc_content_format contentFormat;

  mip_cc_dictionary auditMetadata;

  uint32_t contentMetadataVersion;

  mip_cc_metadata_version_format contentMetadataVersionFormat;

} mip_cc_document_state;

mip_cc_metadata_entry

Entrada de metadatos

Campo Descripción
clave Entrada de clave
valor Entrada de valor
Versión Entrada de versión, debe inicializarse en 0 a menos que se conozca lo contrario
typedef struct {
  const char* key;        
  const char* value;      
  uint32_t version;       
} mip_cc_metadata_entry;