Media services

C# signatures use the types and conventions in Integration. CancellationToken controls the client call. Command objects include inherited fields from ApiCommand where applicable.

IGifs

Search GIFs and retrieve trending GIFs. Source

Task<GifSearchResult> Search(
    string query,
    int page,
    CancellationToken cancellationToken
);

Task<GifSearchResult> GetTrending(
    int page,
    CancellationToken cancellationToken
);

Related data: GifSearchResult.

IMedia

Reserve media identifiers, generate images, inspect processing, and resolve uploaded content. Source

The registered RPC service name is IMedias, despite the C# interface name IMedia. Upload authorization is separate from the existence of these contract methods; see the integration guide. OnGenerate returns null when the image provider declines the description or is not configured.

Task<MediaProgress?> GetProgress(
    Session session,
    MediaId mediaId,
    CancellationToken cancellationToken
);

Task<MediaRef?> GetContent(
    Session session,
    MediaId mediaId,
    CancellationToken cancellationToken
);

Task<MediaId> OnReserveMedia(
    Media_ReserveMedia command,
    CancellationToken cancellationToken
);

Task OnRemoveMedia(
    Media_RemoveMedia command,
    CancellationToken cancellationToken
);

Task OnUpdateProgress(
    Media_UpdateProgress command,
    CancellationToken cancellationToken
);

Task<MediaRef> OnProcessUpload(
    Media_ProcessUpload command,
    CancellationToken cancellationToken
);

Task<MediaRef?> OnGenerate(
    Media_Generate command,
    CancellationToken cancellationToken
);

Related data: MediaId, MediaProgress, MediaRef, Media_Generate, Media_ProcessUpload, Media_RemoveMedia, Media_ReserveMedia, Media_UpdateProgress.

IMediaLinkPreviews

Read a link preview by identifier. Source

Task<LinkPreview?> Get(
    Symbol id,
    CancellationToken cancellationToken
);

Related data: LinkPreview.

IUploads

Create resumable uploads, append bytes or streams, and convert uploads into media. Source

Task<long> GetOffset(
    Session session,
    UploadId uploadId,
    CancellationToken cancellationToken
);

Task<UploadId> OnCreate(
    Uploads_Create command,
    CancellationToken cancellationToken
);

Task OnRemove(
    Uploads_Remove command,
    CancellationToken cancellationToken
);

Task<long> OnAppend(
    Uploads_Append command,
    CancellationToken cancellationToken
);

Task<long> AppendStream(
    Session session,
    UploadId uploadId,
    long offset,
    RpcStream<byte[]> dataStream,
    CancellationToken cancellationToken
);

Task<MediaRef> OnConvertToMediaContent(
    Uploads_ConvertToMediaRef command,
    CancellationToken cancellationToken
);

Task OnStartProcessUpload(
    Uploads_StartProcessUpload command,
    CancellationToken cancellationToken
);

Related data: MediaRef, UploadId, Uploads_Append, Uploads_ConvertToMediaRef, Uploads_Create, Uploads_Remove, Uploads_StartProcessUpload.