Skip to content

client.md

Latest commit

 

History

History
56 lines (38 loc) · 1.98 KB

client.md

File metadata and controls

56 lines (38 loc) · 1.98 KB

Client Class Documentation

The following parameters are configurable for the API Client:

Parameter Type Description
Environment Environment The API environment.
Default: Environment.Production
Timeout TimeSpan Http client timeout.
Default: TimeSpan.FromSeconds(100)

The API client can be initialized as follows:

FirebaseFCM.Standard.FirebaseFCMClient client = new FirebaseFCM.Standard.FirebaseFCMClient.Builder()
    .Environment(FirebaseFCM.Standard.Environment.Production)
    .HttpClientConfig(config => config.NumberOfRetries(0))
    .Build();

Firebase FCMClient Class

The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.

Controllers

Name Description
MiscController Gets MiscController controller.

Properties

Name Description Type
HttpClientConfiguration Gets the configuration of the Http Client associated with this client. IHttpClientConfiguration
Timeout Http client timeout. TimeSpan
Environment Current API environment. Environment

Methods

Name Description Return Type
GetBaseUri(Server alias = Server.Server1) Gets the URL for a particular alias in the current environment and appends it with template parameters. string
ToBuilder() Creates an object of the Firebase FCMClient using the values provided for the builder. Builder

Firebase FCMClient Builder Class

Class to build instances of Firebase FCMClient.

Methods

Name Description Return Type
HttpClientConfiguration(Action<HttpClientConfiguration.Builder> action) Gets the configuration of the Http Client associated with this client. Builder
Timeout(TimeSpan timeout) Http client timeout. Builder
Environment(Environment environment) Current API environment. Builder