NamedValue
Struct for a named value stored in a vault.
| Full name | MFiles.NamedValue |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
key | string | 1 | The name of the value. |
value | TypedValue | 2 | The value as a serialized bytearray. |
Used by methods
- IRPCNamedValueStorage.GetNamedValues -- Gets all named values of one storage type and namespace.
- IRPCNamedValueStorage.SetNamedValues -- Creates or replaces the given named values in one namespace, optionally only if the current values are as expected.
- IRPCObjectOperations.GetFileDownloadUrl -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.
- IRPCSharedLinksPublic.DownloadSharedFile_Begin -- Starts downloading the file of a shared link, without logging in, and returns a download ID, the file size and its MD5 checksum.
- IRPCSharedLinksPublic.GetSharedLinkInfo -- Gets the name, extension and size of the file that a shared link points to, without logging in.
- IRPCSharedLinksPublic.UploadSharedFile -- Uploads a block of new content for a file opened for editing in Office for the web. Used by M-Files clients; applications rarely call it.
- IRPCVaultExtensionMethods.ExecuteAnonymousExtensionMethod -- Passes an anonymous HTTP request, such as a webhook call, to a vault application. Used by the M-Files web server.
Used in fields
AuthDataClientUnion.PluginData.auth_data-- The plug-in's input as named values, for example the token from the identity provider. Non-empty values are encrypted whendata_formatsays so.AuthDataServerUnion.PluginData.auth_data-- The plug-in's output as named values, to process before the next call.ExtensionAuthenticationResponse.data-- The credentials as named text values, as the authentication method expects them. For a user name and password, M-Files clients sendusernameandpassword; for tokens,TokenandRefreshToken.NamedValueArray.value-- An array of the NamedValue structures.NamedValueNamespace.values-- Named value array related to the namespace.GetNamedValuesResponse.values-- The values of the namespace, sorted by key.SetNamedValuesRequest.values-- The values to create or replace. Keys are at most 100 characters.SetNamedValuesRequest.required_existing_value-- Optional. Values that must be current before the write, typically the values you read with GetNamedValues.GetFileDownloadUrlRequest.additional_data-- An optional key-value pairs for additional data from the caller. Can be empty.DownloadSharedFile_BeginRequest.additional_data-- Optional named values; see GetSharedLinkInfo.GetSharedLinkInfoRequest.additional_data-- Optional named values:RECIPIENT_EMAIL,RECIPIENT_ACCESSCODEandACCESS_SESSIONfor links shared with named visitors, andCLIENT_IPfor the event log.UploadSharedFileRequest.additional_data-- Optional named values. Can be empty.ExecuteAnonymousExtensionMethodRequest.http_headers-- The headers of the HTTP request.ExecuteAnonymousExtensionMethodResponse.response_http_headers-- The headers to return in the HTTP response.