Struct ruma_client_api::config::set_room_account_data::v3::Request
source · #[non_exhaustive]pub struct Request {
pub user_id: OwnedUserId,
pub room_id: OwnedRoomId,
pub event_type: RoomAccountDataEventType,
pub data: Raw<AnyRoomAccountDataEventContent>,
}
Expand description
Request type for the set_room_account_data
endpoint.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.user_id: OwnedUserId
The ID of the user to set account_data for.
The access token must be authorized to make requests for this user ID.
room_id: OwnedRoomId
The ID of the room to set account_data on.
event_type: RoomAccountDataEventType
The event type of the account_data to set.
Custom types should be namespaced to avoid clashes.
data: Raw<AnyRoomAccountDataEventContent>
Arbitrary JSON to store as config data.
To create a RawJsonValue
, use serde_json::value::to_raw_value
.
Implementations§
source§impl Request
impl Request
sourcepub fn new<T>(
user_id: OwnedUserId,
room_id: OwnedRoomId,
data: &T,
) -> Result<Self>where
T: RoomAccountDataEventContent,
pub fn new<T>(
user_id: OwnedUserId,
room_id: OwnedRoomId,
data: &T,
) -> Result<Self>where
T: RoomAccountDataEventContent,
sourcepub fn new_raw(
user_id: OwnedUserId,
room_id: OwnedRoomId,
event_type: RoomAccountDataEventType,
data: Raw<AnyRoomAccountDataEventContent>,
) -> Self
pub fn new_raw( user_id: OwnedUserId, room_id: OwnedRoomId, event_type: RoomAccountDataEventType, data: Raw<AnyRoomAccountDataEventContent>, ) -> Self
Creates a new Request
with the given raw data, event type, room ID and user ID.
Trait Implementations§
source§impl OutgoingRequest for Request
impl OutgoingRequest for Request
§type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
§type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
source§fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
source§fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.