 | BrainCloudServiceClientGlobalEntity_UpdateEntityTimeToLiveAsync Method |
[This is preliminary documentation and is subject to change.]
Method updates an existing entity's time to live on the server.
Namespace: Ruyi.SDK.BrainCloudApi
Assembly: SDK.Gen.ServiceAsync (in SDK.Gen.ServiceAsync.dll) Version: 0.9.3.3995
SyntaxC#
public Task<string> GlobalEntity_UpdateEntityTimeToLiveAsync( string entityId, int version, long timeToLive, int clientIndex, CancellationToken cancellationToken )
Parameters
- entityId
- Type: SystemString
The entity ID - version
- Type: SystemInt32
The version of the entity to update - timeToLive
- Type: SystemInt64
Sets expiry time for entity in milliseconds if > 0 - clientIndex
- Type: SystemInt32
@BrainCloud_clientIndex_desc - cancellationToken
- Type: System.ThreadingCancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.GlobalEntity_UpdateEntityTimeToLiveAsync(System.String,System.Int32,System.Int64,System.Int32,System.Threading.CancellationToken)"]
Return Value
Type: TaskString[Missing <returns> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.GlobalEntity_UpdateEntityTimeToLiveAsync(System.String,System.Int32,System.Int64,System.Int32,System.Threading.CancellationToken)"]
See Also