Struktury
mip_cc_application_info
A struct that includes application specific information
| Pole | Opis |
|---|---|
| applicationId | Identyfikator aplikacji ustawiony w portalu AAD (Powinien to być identyfikator GUID bez nawiasów). |
| nazwa_aplikacji | Nazwa aplikacji,(Should only contain valid ASCII character excluding ';') |
| applicationVersion | Wersja używanej aplikacji (powinna zawierać tylko prawidłowy znak ASCII bez znaku ';') |
typedef struct {
const char* applicationId;
const char* applicationName;
const char* applicationVersion;
} mip_cc_application_info;
mip_cc_oauth2_challenge
Informacje udostępniane przez serwer w celu wygenerowania tokenu OAuth2
| Pole | Opis |
|---|---|
| urząd | Urząd OAuth2 |
| zasób | Zasób OAuth2 |
| zakres | Zakres protokołu OAuth2 |
typedef struct {
const char* authority;
const char* resource;
const char* scope;
} mip_cc_oauth2_challenge;
mip_cc_handle
Uchwyt nieprzezroczystości na obiekt MIP
| Pole | Opis |
|---|---|
| typeId | Unikatowy numer identyfikacyjny dla określonego typu uchwytu |
| dane | Nieprzetworzone dane uchwytu |
typedef struct {
uint32_t typeId;
void* data;
} mip_cc_handle;
mip_cc_guid
IDENTYFIKATOR GUID
typedef struct {
char guid[37];
} mip_cc_guid;
mip_cc_kv_pair
Para klucz/wartość
| Pole | Opis |
|---|---|
| klawisz | Klucz |
| wartość | Wartość |
typedef struct {
const char* key;
const char* value;
} mip_cc_kv_pair;
mip_cc_error
Informacje o błędzie
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
Nagłówek żądania/odpowiedzi HTTP
| Pole | Opis |
|---|---|
| nazwa | Nazwa/klucz nagłówka |
| wartość | Wartość nagłówka |
typedef struct {
const char* name;
const char* value;
} mip_cc_http_header;
mip_cc_http_request
Żądanie HTTP
| Pole | Opis |
|---|---|
| identyfikator | Unikatowy identyfikator żądania skorelowany z taką samą właściwością w programie mip_cc_http_response |
| wpisz tekst | Typ żądania HTTP (np. GET a POST) |
| adres URL | Adres URL żądania HTTP |
| bodySize | Rozmiar treści żądania HTTP w bajtach |
| treść | Bufor zawiera treść żądania HTTP |
| headersCount | Liczba nagłówków żądań HTTP |
| nagłówki | Bufor zawierający nagłówki żądań 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
Odpowiedź HTTP
| Pole | Opis |
|---|---|
| identyfikator | Unikatowy identyfikator żądania skorelowany z taką samą właściwością w programie mip_cc_http_request |
| kod stanu | Kod stanu odpowiedzi HTTP |
| bodySize | Rozmiar treści odpowiedzi HTTP w bajtach |
| treść | Bufor zawiera treść odpowiedzi HTTP |
| headersCount | Liczba nagłówków odpowiedzi HTTP |
| nagłówki | Bufor zawierający nagłówki odpowiedzi 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
Instrukcja zawierająca informacje identyfikacyjne użytkownika
| Pole | Opis |
|---|---|
| Adres e-mail | Adres e-mail użytkownika |
| nazwa | Przyjazna dla użytkownika nazwa używana do oznaczania zawartości. |
typedef struct {
const char* email;
const char* name;
} mip_cc_identity;
mip_cc_feature_override
Definiowanie stanu włączone/wyłączonej pojedynczej funkcji
| Pole | Opis |
|---|---|
| funkcja | Nazwa funkcji |
| wartość | Stan włączony/wyłączony |
typedef struct {
mip_cc_flighting_feature feature;
bool value;
} mip_cc_feature_override;
mip_cc_user_rights
Grupa użytkowników i skojarzone z nimi prawa
| Pole | Opis |
|---|---|
| użytkownicy | Lista użytkowników |
| usersCount | Liczba użytkowników |
| prawa | Lista praw |
| rightsCount | Liczba praw |
typedef struct {
const char** users;
int64_t usersCount;
const char** rights;
int64_t rightsCount;
} mip_cc_user_rights;
mip_cc_user_roles
Grupa użytkowników i skojarzone z nimi role
| Pole | Opis |
|---|---|
| użytkownicy | Lista użytkowników |
| usersCount | Liczba użytkowników |
| role | Lista ról |
| rolesCount | Liczba ról |
typedef struct {
const char** users;
int64_t usersCount;
const char** roles;
int64_t rolesCount;
} mip_cc_user_roles;
mip_cc_async_task
Definiowanie pojedynczego żądania wysłania zadania synchronizacji
| Pole | Opis |
|---|---|
| identyfikator | Identyfikator zadania |
| delayMs | Opóźnienie do wykonania zadania (w milisekundach) |
| executeOnIndependentThread | Czy to zadanie powinno zostać wykonane w całkowicie niezależnym wątku, czy można ponownie użyć wątku udostępnionego |
typedef struct {
const char* id;
int64_t delayMs;
bool executeOnIndependentThread;
} mip_cc_async_task;
mip_cc_application_action_state
Reprezentuje bieżący stan aplikacji w związku z jej wykonaniem operacji związanej z etykietami.
| Pole | Opis |
|---|---|
| actionState | W tym artykule opisano, czy/w jaki sposób aplikacja próbuje zmienić stan etykiet. |
| etykieta newLabel | Jeśli 'actionType' to 'UPDATE': New label. |
| newLabelExtendedProperties | Jeśli 'actionType' to 'UPDATE': Dodatkowe właściwości, które należy zapisywać w metadanych. |
| newLabelAssignmentMethod | Jeśli 'actionType' to 'UPDATE': metoda przypisywania nowej etykiety. |
| isDowngradeJustified | Jeśli 'actionType' to 'UPDATE': Czy zmiana etykiety na starszą wersję została wy uzasadnienie przez użytkownika. |
| downgradeJustification | Jeśli 'actionType' to 'UPDATE': Etykieta obniży poziom justowania podany przez użytkownika. |
| supportedActions | Maska wytłaniająca opis akcji związanych z etykietami, które może wykonywać aplikacja. |
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
Definicja funkcji callback do pobierania danych metatdata dokumentu filtrowanych według nazwy/prefiksu.
| Pole | Opis |
|---|---|
| dataState | Stan danych dokumentu w przypadku interakcji aplikacji z nimi. |
| contentMetadataCallback | Wywołanie zwrotne metadanych dokumentu. |
| protectionDescriptor | Deskryptor ochrony, jeśli dokument jest obecnie chroniony, w innym przypadku null. |
| contentFormat | Format dokumentu (plik a wiadomość e-mail). |
| auditMetadata | Opcjonalne metadane specyficzne dla aplikacji używane podczas wysyłania raportów inspekcji. Rozpoznane wartości: "Nadawca": adres e-mail nadawcy; 'Adresaci': tablica JSON adresatów wiadomości e-mail; "LastModifiedBy": adres e-mail użytkownika, który ostatnio zmodyfikował dokument; "Data ostatniej modyfikacji": data ostatniej modyfikacji dokumentu |
| contentMetadataVersion | Wersja metadanych dokumentu, domyślnie powinna mieć wartość 0. |
| contentMetadataVersionFormat | W tym artykule opisano sposób przetwarzania wersji metadanych. |
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
Wpis metadanych
| Pole | Opis |
|---|---|
| klawisz | Wpis klucza |
| wartość | Wpis wartości |
| Wersja | Wpis wersji powinien być zainicjowany na wartość 0, chyba że określono inaczej |
typedef struct {
const char* key;
const char* value;
uint32_t version;
} mip_cc_metadata_entry;