PlayerApi class

DO NOT EDIT THIS FILE. TO ADJUST THIS CLASS, USE PlayerApiMixin

The final API is constructed by:

  • taking the PlayerApiBase class
  • applying a mixin PlayerApiMixin ] (which allows us to inject other convenience functions) The mixin lives outside of the code generator, so it's used to do any manual tweaking
  • Applying the SignalingApiMixin, so events automatically propagate
Inheritance
Implemented types
Mixed-in types

Constructors

PlayerApi(ApiClient apiClient, ApiRegistry apis)

Properties

apiClient → ApiClient
final
apis → ApiRegistry
A reference back to the api registry
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
mtype → MSchemaRef
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

clone(IPlayer source) → IPlayer
Copies values from one entity into another. This clone operation is important because it allows
inherited
create(IPlayer player) → Future<IPlayer>
override
delete(String id) → Future<DeleteResponse>
override
initialize(IPlayer entity) → IPlayer
inherited
instantiate([dynamic json]) → IPlayer
inherited
keyToId(MKey? key) → String?
inherited
list({double? limit, double? offset}) → Future<IPlayerList>
override
load(String id) → Future<IPlayer>
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
takeFrom(IPlayer source, IPlayer target) → void
Copies all data from source into target. Used when you want to maintain a reference to target, but want to inject new values from source
inherited
toString() → String
A string representation of this object.
inherited
update(String id, IPlayer player) → Future<ChangeResult>
override

Operators

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