SessionConfigClientSecret class abstract

Ephemeral key returned by the API.

Available extensions
Annotations
  • @freezed

Constructors

SessionConfigClientSecret({@JsonKey.new(includeIfNull: false) String? value, @JsonKey.new(name: 'expires_at', includeIfNull: false) int? expiresAt})
Factory constructor for SessionConfigClientSecret
const
factory
SessionConfigClientSecret.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $SessionConfigClientSecretCopyWith<SessionConfigClientSecret>
Create a copy of SessionConfigClientSecret with the given fields replaced by the non-null parameter values.
no setterinherited
expiresAt int?
Timestamp for when the token expires. Currently, all tokens expire after one minute.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
value String?
Ephemeral key usable in client environments to authenticate connections to the Realtime API. Use this in client-side environments rather than a standard API token, which should only be used server-side.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_SessionConfigClientSecret value)) → TResult

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_SessionConfigClientSecret value)?) → TResult?

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_SessionConfigClientSecret value)?, {required TResult orElse()}) → TResult

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String? value, int? expiresAt)?, {required TResult orElse()}) → TResult

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes this SessionConfigClientSecret to a JSON map.
inherited
toMap() Map<String, dynamic>
Map representation of object (not serialized)
toString() String
A string representation of this object.
inherited
validateSchema() String?
Perform validations on the schema property values
when<TResult extends Object?>(TResult $default(String? value, int? expiresAt)) → TResult

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? value, int? expiresAt)?) → TResult?

Available on SessionConfigClientSecret, provided by the SessionConfigClientSecretPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

propertyNames → const List<String>
List of all property names of schema