Struct azure_functions::bindings::SignalRMessage

pub struct SignalRMessage {
    pub user_id: Option<String>,
    pub group_name: Option<String>,
    pub target: String,
    pub arguments: Vec<Value>,
}

Represents the SignalR message 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 message.
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 returns a SignalRMessage binding:

use azure_functions::{
    bindings::{HttpRequest, SignalRMessage},
    func,
};
use serde_json::{to_value, Value};

#[func]
#[binding(name = "req", auth_level = "anonymous", methods = "post")]
#[binding(name = "$return", hub_name = "chat", connection = "myconnection")]
pub fn send_message(req: HttpRequest) -> SignalRMessage {
    SignalRMessage {
        user_id: req.query_params().get("user").map(|v| v.to_owned()),
        group_name: req.query_params().get("group").map(|v| v.to_owned()),
        target: "newMessage".to_owned(),
        arguments: vec![req.query_params().get("message").map_or(Value::Null, |v| to_value(v).unwrap())],
    }
}

Fields

user_id: Option<String>

The optional user id to send the message to.

group_name: Option<String>

The optional group name to send the message to.

target: String

The target method name to invoke on each SignalR client.

arguments: Vec<Value>

The arguments to pass to the target method.

Trait Implementations

impl Clone for SignalRMessage

fn clone(&self) -> SignalRMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignalRMessage

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

Formats the value using the given formatter.

impl Serialize for SignalRMessage

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 SignalRMessage

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

Deserialize this value from the given Serde deserializer.