collections_process_inbox_message¶
Receive a federated message by a collection
Functions
- async pydelfini.delfini_core.api.federation.collections_process_inbox_message.asyncio(collection_id, version_id, *, client, body)[source]¶
Receive a federated message by a collection
This method is primarily for handling activities coming from federated sources. Users creating activities to perform actions on collections should post them to their own inbox with the proper addressing.
- Parameters:
collection_id (str)
version_id (str)
body (FederationActivity)
body
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[Any]
- Return type:
- async pydelfini.delfini_core.api.federation.collections_process_inbox_message.asyncio_detailed(collection_id, version_id, *, client, body)[source]¶
Receive a federated message by a collection
This method is primarily for handling activities coming from federated sources. Users creating activities to perform actions on collections should post them to their own inbox with the proper addressing.
- Parameters:
collection_id (str)
version_id (str)
body (FederationActivity)
body
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[Any, ServerError]]
- Return type:
- pydelfini.delfini_core.api.federation.collections_process_inbox_message.sync(collection_id, version_id, *, client, body)[source]¶
Receive a federated message by a collection
This method is primarily for handling activities coming from federated sources. Users creating activities to perform actions on collections should post them to their own inbox with the proper addressing.
- Parameters:
collection_id (str)
version_id (str)
body (FederationActivity)
body
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[Any]
- Return type:
- pydelfini.delfini_core.api.federation.collections_process_inbox_message.sync_detailed(collection_id, version_id, *, client, body)[source]¶
Receive a federated message by a collection
This method is primarily for handling activities coming from federated sources. Users creating activities to perform actions on collections should post them to their own inbox with the proper addressing.
- Parameters:
collection_id (str)
version_id (str)
body (FederationActivity)
body
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[Any, ServerError]]
- Return type: