Sc2RanksService.GetCustomDivisionCharacterListBegin Method

Sc2RanksService GetCustomDivisionCharacterListBegin Method

NuGardt

Returns the characters in the custom division without any team data, filtered by the passed params.

Namespace: NuGardt.SC2Ranks.API
Assembly: NuGardt.SC2Ranks.API (in NuGardt.SC2Ranks.API.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

C++

Copy to Clipboard Print

public IAsyncResult GetCustomDivisionCharacterListBegin(
	Object Key,
	string DivisionID,
	eSc2RanksRegion Region,
	AsyncCallback Callback,
	int Limit = 50,
	int Page = 1,
	bool IgnoreCache = false
)

public IAsyncResult GetCustomDivisionCharacterListBegin(
	Object Key,
	string DivisionID,
	eSc2RanksRegion Region,
	AsyncCallback Callback,
	int Limit = 50,
	int Page = 1,
	bool IgnoreCache = false
)

Public Function GetCustomDivisionCharacterListBegin ( 
	Key As Object,
	DivisionID As String,
	Region As eSc2RanksRegion,
	Callback As AsyncCallback,
	Optional Limit As Integer = 50,
	Optional Page As Integer = 1,
	Optional IgnoreCache As Boolean = false
) As IAsyncResult

Public Function GetCustomDivisionCharacterListBegin ( 
	Key As Object,
	DivisionID As String,
	Region As eSc2RanksRegion,
	Callback As AsyncCallback,
	Optional Limit As Integer = 50,
	Optional Page As Integer = 1,
	Optional IgnoreCache As Boolean = false
) As IAsyncResult

public:
IAsyncResult^ GetCustomDivisionCharacterListBegin(
	Object^ Key, 
	String^ DivisionID, 
	eSc2RanksRegion Region, 
	AsyncCallback^ Callback, 
	int Limit = 50, 
	int Page = 1, 
	bool IgnoreCache = false
)

public:
IAsyncResult^ GetCustomDivisionCharacterListBegin(
	Object^ Key, 
	String^ DivisionID, 
	eSc2RanksRegion Region, 
	AsyncCallback^ Callback, 
	int Limit = 50, 
	int Page = 1, 
	bool IgnoreCache = false
)

Parameters

Key: Type: System Object
Can contain anything. Useful for tracking asynchronous calls. Is returned when the End method is called.

DivisionID: Type: System String
The division identifier.

Region: Type: NuGardt.SC2Ranks.API eSc2RanksRegion
The region of the character.

Callback: Type: System AsyncCallback
Address of a method to call when a result is available.

Limit (Optional): Type: System Int32
The maximum limit of results returned. Cannot exceed MaximumRequestLimit.

Page (Optional): Type: System Int32
The page of data to return based on the Limit.

IgnoreCache (Optional): Type: System Boolean
Optional. Default is False. Ignores any cached data that might be available when caching is enabled.

Return Value

Type:

IAsyncResult
Return an System.Exception if an error occurred otherwise Nothing.

Remarks