createRoom method

Future<DynamiteResponse<PublicShareAuthCreateRoomResponseApplicationJson, void>> createRoom({
  1. required String shareToken,
  2. PublicShareAuthCreateRoomApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Creates a new room for video verification (requesting the password of a share).

The new room is a public room associated with a "share:password" object with the ID of the share token. Unlike normal rooms in which the owner is the user that created the room these are special rooms always created by a guest or user on behalf of a registered user, the sharer, who will be the owner of the room. The share must have "send password by Talk" enabled; an error is returned otherwise.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • shareToken Token of the file share.
  • apiVersion Defaults to v1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Room created successfully
  • 404: Share not found

See:

  • createRoomRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<PublicShareAuthCreateRoomResponseApplicationJson, void>> createRoom({
  required String shareToken,
  PublicShareAuthCreateRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = createRoomRaw(
    shareToken: shareToken,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}