Struct azure_functions::bindings::SignalRGroupAction

pub struct SignalRGroupAction {
    pub group_name: String,
    pub user_id: String,
    pub action: GroupAction,
}

Represents the SignalR group action output binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
hub_name	The name of the SignalR hub that will receive the group action.
connection	The name of the app setting that contains the SignalR Service connection string. Defaults to AzureSignalRConnectionString.

Examples

This example implements an HTTP-triggered Azure Function that adds a user to a group:

use azure_functions::{
    bindings::{HttpRequest, SignalRGroupAction},
    func,
    signalr::GroupAction,
};

#[func]
#[binding(name = "req", auth_level = "anonymous", methods = "post")]
#[binding(name = "$return", hub_name = "chat", connection = "myconnection")]
pub fn add_to_group(req: HttpRequest) -> SignalRGroupAction {
    SignalRGroupAction {
        user_id: req.query_params().get("user").unwrap().to_owned(),
        group_name: req.query_params().get("group").unwrap().to_owned(),
        action: GroupAction::Add,
    }
}

Fields

group_name: String

The name of the group to operate on.

user_id: String

The user id to operate on.

action: GroupAction

The action to take.

Trait Implementations

impl Clone for SignalRGroupAction

fn clone(&self) -> SignalRGroupAction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalRGroupAction

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for SignalRGroupAction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SignalRGroupAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.