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: {},
});

const result = await client.media.decrypt({
  message: {},
});

curl -X POST "http://localhost:8080/api/media/decrypt" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "message": {}
  }'

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",
});

const result = await client.media.download({
  message: {},
  path: "path",
});

curl -X POST "http://localhost:8080/api/media/download" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "message": {},
    "path": "path"
  }'

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!

Was this helpful?

On this page