IRPCVaultExtensionMethods.ExecuteExtensionMethod
Vault API / standard write session idempotent returns metadata structure version
Runs an event handler method by name. In new code use RunExtensionMethod.
| Service | Vault extension methods MFiles.IRPCVaultExtensionMethods |
|---|---|
| gRPC method | /MFiles.IRPCVaultExtensionMethods/ExecuteExtensionMethod |
| HTTP (mf-http-grpc) | POST /grpc/v1/execute-extension-method |
| Request | ExecuteExtensionMethodRequest |
| Response | ExecuteExtensionMethodResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Same as RunExtensionMethod with
an all-zero
application_idand uncompressed input. - An unknown name fails with "Not found. (<name>)".
Request: ExecuteExtensionMethodRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
script_identifier | string | The name of the VaultExtensionMethod event handler. |
input | string | The input passed to the method. |
Response: ExecuteExtensionMethodResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
output | string | The output of the method. |
Related methods
- RunExtensionMethod -- Runs a vault extension method, either an event handler method or an application extension method, with optional compression of the input and output.
- ExecuteExtensionMethodEx -- Runs an extension method of a vault application. In new code use RunExtensionMethod.