shareObjectToChatRaw method

  1. @experimental
DynamiteRawResponse<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders> shareObjectToChatRaw({
  1. required String objectType,
  2. required String objectId,
  3. required String token,
  4. String? metaData,
  5. String? actorDisplayName,
  6. String? referenceId,
  7. ChatShareObjectToChatApiVersion? apiVersion,
  8. bool? oCSAPIRequest,
})

Sends a rich-object to the given room.

The author and timestamp are automatically set to the current user/guest and time.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • objectType Type of the object.
  • objectId ID of the object.
  • metaData Additional metadata. Defaults to ''.
  • actorDisplayName Guest name. Defaults to ''.
  • referenceId Reference ID. Defaults to ''.
  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Object shared successfully
  • 400: Sharing object is not possible
  • 404: Actor not found
  • 413: Message too long

See:

Implementation

@experimental
DynamiteRawResponse<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders>
    shareObjectToChatRaw({
  required String objectType,
  required String objectId,
  required String token,
  String? metaData,
  String? actorDisplayName,
  String? referenceId,
  ChatShareObjectToChatApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  final $objectType = jsonSerializers.serialize(objectType, specifiedType: const FullType(String));
  _parameters['objectType'] = $objectType;

  final $objectId = jsonSerializers.serialize(objectId, specifiedType: const FullType(String));
  _parameters['objectId'] = $objectId;

  final $token = jsonSerializers.serialize(token, specifiedType: const FullType(String));
  dynamite_utils.checkPattern($token as String?, RegExp(r'^[a-z0-9]{4,30}$'), 'token');
  _parameters['token'] = $token;

  var $metaData = jsonSerializers.serialize(metaData, specifiedType: const FullType(String));
  $metaData ??= '';
  _parameters['metaData'] = $metaData;

  var $actorDisplayName = jsonSerializers.serialize(actorDisplayName, specifiedType: const FullType(String));
  $actorDisplayName ??= '';
  _parameters['actorDisplayName'] = $actorDisplayName;

  var $referenceId = jsonSerializers.serialize(referenceId, specifiedType: const FullType(String));
  $referenceId ??= '';
  _parameters['referenceId'] = $referenceId;

  var $apiVersion =
      jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ChatShareObjectToChatApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/share{?objectType*,objectId*,metaData*,actorDisplayName*,referenceId*}',
  ).expand(_parameters);
  return DynamiteRawResponse<ChatShareObjectToChatResponseApplicationJson, ChatChatShareObjectToChatHeaders>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {201},
    ),
    bodyType: const FullType(ChatShareObjectToChatResponseApplicationJson),
    headersType: const FullType(ChatChatShareObjectToChatHeaders),
    serializers: jsonSerializers,
  );
}