V1Alpha1.RemoteInteractionServiceClient Class

Namespace: Improbable.SpatialOS.RemoteInteraction

RemoteInteractionService client wrapper, for convenient use.

If you use the GDK for Unreal version 0.10 or later, this class is not compatible with the Standard Runtime variant. If you want to use this class, you must use the Compatibility Mode Runtime variant.


Static Properties

DefaultEndpoint
ispc::PlatformApiEndpoint DefaultEndpoint { get; }

The default endpoint for the RemoteInteractionService service, which is a host of "platform.api.improbable.io" and a port of 443.


Properties

GrpcClient
RemoteInteractionService.RemoteInteractionServiceClient GrpcClient { get; }

The underlying gRPC RemoteInteractionService client.


Static Methods

Create
RemoteInteractionServiceClient Create(ispc::PlatformApiEndpoint endpoint = null, ispc::PlatformCredential credentials = null, RemoteInteractionServiceSettings settings = null)

Synchronously creates a RemoteInteractionServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.

Returns:
The created RemoteInteractionServiceClient.

Parameters

Create
RemoteInteractionServiceClient Create(grpccore::Channel channel, RemoteInteractionServiceSettings settings = null)

Creates a RemoteInteractionServiceClient which uses the specified channel for remote operations.

Returns:
The created RemoteInteractionServiceClient.

Parameters


Methods

EntityCommandAsync
stt::Task<EntityCommandResponse> EntityCommandAsync(Deployment target, string workerType, string workerId, EntityCommandRequest.Types.EntityCommandTarget componentTarget, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters

EntityCommandAsync
stt::Task<EntityCommandResponse> EntityCommandAsync(Deployment target, string workerType, string workerId, EntityCommandRequest.Types.EntityCommandTarget componentTarget, pb::ByteString binary, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters

EntityCommand
EntityCommandResponse EntityCommand(Deployment target, string workerType, string workerId, EntityCommandRequest.Types.EntityCommandTarget componentTarget, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters

EntityCommandAsync
stt::Task<EntityCommandResponse> EntityCommandAsync(EntityCommandRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • EntityCommandRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

EntityCommandAsync
stt::Task<EntityCommandResponse> EntityCommandAsync(EntityCommandRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • EntityCommandRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

EntityCommand
EntityCommandResponse EntityCommand(EntityCommandRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • EntityCommandRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

ReserveEntityIdAsync
stt::Task<ReserveEntityIdResponse> ReserveEntityIdAsync(Deployment target, uint? numberOfIds, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • uint? numberOfIds :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

ReserveEntityIdAsync
stt::Task<ReserveEntityIdResponse> ReserveEntityIdAsync(Deployment target, uint? numberOfIds, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • uint? numberOfIds :
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

ReserveEntityId
ReserveEntityIdResponse ReserveEntityId(Deployment target, uint? numberOfIds, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • Deployment target :
  • uint? numberOfIds :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

ReserveEntityIdAsync
stt::Task<ReserveEntityIdResponse> ReserveEntityIdAsync(ReserveEntityIdRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • ReserveEntityIdRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

ReserveEntityIdAsync
stt::Task<ReserveEntityIdResponse> ReserveEntityIdAsync(ReserveEntityIdRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • ReserveEntityIdRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

ReserveEntityId
ReserveEntityIdResponse ReserveEntityId(ReserveEntityIdRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • ReserveEntityIdRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

CreateEntityAsync
stt::Task<CreateEntityResponse> CreateEntityAsync(Deployment target, long entityId, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • pb::ByteString binary :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

CreateEntityAsync
stt::Task<CreateEntityResponse> CreateEntityAsync(Deployment target, long entityId, pb::ByteString binary, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • pb::ByteString binary :
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

CreateEntity
CreateEntityResponse CreateEntity(Deployment target, long entityId, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • pb::ByteString binary :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

CreateEntityAsync
stt::Task<CreateEntityResponse> CreateEntityAsync(CreateEntityRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • CreateEntityRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

CreateEntityAsync
stt::Task<CreateEntityResponse> CreateEntityAsync(CreateEntityRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • CreateEntityRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

CreateEntity
CreateEntityResponse CreateEntity(CreateEntityRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • CreateEntityRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteEntityAsync
stt::Task<DeleteEntityResponse> DeleteEntityAsync(Deployment target, long entityId, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteEntityAsync
stt::Task<DeleteEntityResponse> DeleteEntityAsync(Deployment target, long entityId, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

DeleteEntity
DeleteEntityResponse DeleteEntity(Deployment target, long entityId, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • Deployment target :
  • long entityId :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteEntityAsync
stt::Task<DeleteEntityResponse> DeleteEntityAsync(DeleteEntityRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • DeleteEntityRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

DeleteEntityAsync
stt::Task<DeleteEntityResponse> DeleteEntityAsync(DeleteEntityRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • DeleteEntityRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

DeleteEntity
DeleteEntityResponse DeleteEntity(DeleteEntityRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • DeleteEntityRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

EntityQueryAsync
stt::Task<EntityQueryResponse> EntityQueryAsync(Deployment target, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • pb::ByteString binary :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

EntityQueryAsync
stt::Task<EntityQueryResponse> EntityQueryAsync(Deployment target, pb::ByteString binary, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • Deployment target :
  • pb::ByteString binary :
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

EntityQuery
EntityQueryResponse EntityQuery(Deployment target, pb::ByteString binary, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • Deployment target :
  • pb::ByteString binary :
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

EntityQueryAsync
stt::Task<EntityQueryResponse> EntityQueryAsync(EntityQueryRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
A Task containing the RPC response.

Parameters
  • EntityQueryRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

EntityQueryAsync
stt::Task<EntityQueryResponse> EntityQueryAsync(EntityQueryRequest request, st::CancellationToken cancellationToken)

Returns:
A Task containing the RPC response.

Parameters
  • EntityQueryRequest request : The request object containing all of the parameters for the API call.
  • st::CancellationToken cancellationToken : A st::CancellationToken to use for this RPC.

EntityQuery
EntityQueryResponse EntityQuery(EntityQueryRequest request, gaxgrpc::CallSettings callSettings = null)

Returns:
The RPC response.

Parameters
  • EntityQueryRequest request : The request object containing all of the parameters for the API call.
  • gaxgrpc::CallSettings callSettings : If not null, applies overrides to this RPC call.

Updated 11 months ago


V1Alpha1.RemoteInteractionServiceClient Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.