Media Client API
Generated client method reference for the media namespace.
Media Client API
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
This page documents 2 schema-registry client methods in the media namespace.
decryptMedia
Decrypts media from a message
Overview
| Prop | Value |
|---|---|
| Namespace | media |
| Action | read |
| Functionality | both |
| Positional parameter order | message |
| Aliases | media.decrypt |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | POST | /api/media/decrypt | decryptMedia | Active |
| Alias | POST | /api/decryptMedia | decryptMedia | Active |
Usage
const result = await client.decryptMedia({
message: {},
});
// namespaced form: client.media.decrypt(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | string |
downloadMedia
Downloads and decrypts media from a message to a file
Overview
| Prop | Value |
|---|---|
| Namespace | media |
| Action | read |
| Functionality | both |
| Positional parameter order | message, path |
| Aliases | media.download |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | POST | /api/media/download | downloadMedia | Active |
| Alias | POST | /api/downloadMedia | downloadMedia | Active |
Usage
const result = await client.downloadMedia({
message: {},
path: "path",
});
// namespaced form: client.media.download(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | string |
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!