initialPayload property
dynamic
initialPayload
final
Payload to be sent with the connection_init request.
Can be a literal value, a callback, or an async callback. End value must be valid argument for json.encode.
If initialPayload is a function, it is re-invoked on every connection and reconnection attempt, so authentication tokens inside the payload can be refreshed between attempts.
Internal usage is roughly:
Future<InitOperation> get initOperation async {
if (initialPayload is Function) {
final dynamic payload = await initialPayload();
return InitOperation(payload);
} else {
return InitOperation(initialPayload);
}
}
Implementation
final dynamic initialPayload;