-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update pages for Kotlin SDK v9.1.0 release.
- Loading branch information
1 parent
458ab65
commit ada2a6f
Showing
2,928 changed files
with
19,214 additions
and
18,063 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...bnub-core-api/com.pubnub.api.endpoints/-has-overridable-config/configuration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| //[pubnub-core-api](../../../index.md)/[com.pubnub.api.endpoints](../index.md)/[HasOverridableConfig](index.md)/[configuration](configuration.md) | ||
|
|
||
| # configuration | ||
|
|
||
| [jvm]\ | ||
| abstract val [configuration](configuration.md): [BasePNConfiguration](../../com.pubnub.api.v2/-base-p-n-configuration/index.md) |
18 changes: 18 additions & 0 deletions
18
...e-api/pubnub-core-api/com.pubnub.api.endpoints/-has-overridable-config/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| //[pubnub-core-api](../../../index.md)/[com.pubnub.api.endpoints](../index.md)/[HasOverridableConfig](index.md) | ||
|
|
||
| # HasOverridableConfig | ||
|
|
||
| [jvm]\ | ||
| interface [HasOverridableConfig](index.md) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Summary | | ||
| |---|---| | ||
| | [configuration](configuration.md) | [jvm]<br>abstract val [configuration](configuration.md): [BasePNConfiguration](../../com.pubnub.api.v2/-base-p-n-configuration/index.md) | | ||
|
|
||
| ## Functions | ||
|
|
||
| | Name | Summary | | ||
| |---|---| | ||
| | [overrideConfiguration](override-configuration.md) | [jvm]<br>abstract fun [overrideConfiguration](override-configuration.md)(configuration: [BasePNConfiguration](../../com.pubnub.api.v2/-base-p-n-configuration/index.md)) | |
6 changes: 6 additions & 0 deletions
6
...-api/com.pubnub.api.endpoints/-has-overridable-config/override-configuration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| //[pubnub-core-api](../../../index.md)/[com.pubnub.api.endpoints](../index.md)/[HasOverridableConfig](index.md)/[overrideConfiguration](override-configuration.md) | ||
|
|
||
| # overrideConfiguration | ||
|
|
||
| [jvm]\ | ||
| abstract fun [overrideConfiguration](override-configuration.md)(configuration: [BasePNConfiguration](../../com.pubnub.api.v2/-base-p-n-configuration/index.md)) |
9 changes: 9 additions & 0 deletions
9
pubnub-core/pubnub-core-api/pubnub-core-api/com.pubnub.api.endpoints/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| //[pubnub-core-api](../../index.md)/[com.pubnub.api.endpoints](index.md) | ||
|
|
||
| # Package-level declarations | ||
|
|
||
| ## Types | ||
|
|
||
| | Name | Summary | | ||
| |---|---| | ||
| | [HasOverridableConfig](-has-overridable-config/index.md) | [jvm]<br>interface [HasOverridableConfig](-has-overridable-config/index.md) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
...ore-api/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/auth-key.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[authKey](auth-key.md) | ||
|
|
||
| # authKey | ||
|
|
||
| [jvm]\ | ||
| abstract val [authKey](auth-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | ||
|
|
||
| If Access Manager is utilized, client will use this authKey in all restricted requests. |
12 changes: 12 additions & 0 deletions
12
.../com.pubnub.api.v2/-base-p-n-configuration-override/-builder/connect-timeout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[connectTimeout](connect-timeout.md) | ||
|
|
||
| # connectTimeout | ||
|
|
||
| [jvm]\ | ||
| abstract val [connectTimeout](connect-timeout.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | ||
|
|
||
| How long before the client gives up trying to connect with the server. | ||
|
|
||
| The value is in seconds. | ||
|
|
||
| Defaults to 5. |
8 changes: 8 additions & 0 deletions
8
...pi/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/crypto-module.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[cryptoModule](crypto-module.md) | ||
|
|
||
| # cryptoModule | ||
|
|
||
| [jvm]\ | ||
| abstract val [cryptoModule](crypto-module.md): [CryptoModule](../../../com.pubnub.api.crypto/-crypto-module/index.md)? | ||
|
|
||
| CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted. |
10 changes: 10 additions & 0 deletions
10
...api.v2/-base-p-n-configuration-override/-builder/include-instance-identifier.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[includeInstanceIdentifier](include-instance-identifier.md) | ||
|
|
||
| # includeInstanceIdentifier | ||
|
|
||
| [jvm]\ | ||
| abstract val [includeInstanceIdentifier](include-instance-identifier.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | ||
|
|
||
| Whether to include a PubNub.instanceId with every request. | ||
|
|
||
| Defaults to `false`. |
10 changes: 10 additions & 0 deletions
10
....api.v2/-base-p-n-configuration-override/-builder/include-request-identifier.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[includeRequestIdentifier](include-request-identifier.md) | ||
|
|
||
| # includeRequestIdentifier | ||
|
|
||
| [jvm]\ | ||
| abstract val [includeRequestIdentifier](include-request-identifier.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | ||
|
|
||
| Whether to include a PubNub.requestId with every request. | ||
|
|
||
| Defaults to `true`. |
22 changes: 22 additions & 0 deletions
22
...b-core-api/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md) | ||
|
|
||
| # Builder | ||
|
|
||
| [jvm]\ | ||
| interface [Builder](index.md) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Summary | | ||
| |---|---| | ||
| | [authKey](auth-key.md) | [jvm]<br>abstract val [authKey](auth-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>If Access Manager is utilized, client will use this authKey in all restricted requests. | | ||
| | [connectTimeout](connect-timeout.md) | [jvm]<br>abstract val [connectTimeout](connect-timeout.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>How long before the client gives up trying to connect with the server. | | ||
| | [cryptoModule](crypto-module.md) | [jvm]<br>abstract val [cryptoModule](crypto-module.md): [CryptoModule](../../../com.pubnub.api.crypto/-crypto-module/index.md)?<br>CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted. | | ||
| | [includeInstanceIdentifier](include-instance-identifier.md) | [jvm]<br>abstract val [includeInstanceIdentifier](include-instance-identifier.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Whether to include a PubNub.instanceId with every request. | | ||
| | [includeRequestIdentifier](include-request-identifier.md) | [jvm]<br>abstract val [includeRequestIdentifier](include-request-identifier.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Whether to include a PubNub.requestId with every request. | | ||
| | [nonSubscribeReadTimeout](non-subscribe-read-timeout.md) | [jvm]<br>abstract val [nonSubscribeReadTimeout](non-subscribe-read-timeout.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>For non subscribe operations (publish, herenow, etc), This property relates to a read timeout that is applied from the moment the connection between a client and the server has been successfully established. It defines a maximum time of inactivity between two data packets when waiting for the server’s response. | | ||
| | [publishKey](publish-key.md) | [jvm]<br>abstract val [publishKey](publish-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>The publish key from the admin panel (only required if publishing). | | ||
| | [retryConfiguration](retry-configuration.md) | [jvm]<br>abstract val [retryConfiguration](retry-configuration.md): [RetryConfiguration](../../../com.pubnub.api.retry/-retry-configuration/index.md)<br>Retry configuration for requests. Defaults to [RetryConfiguration.None](../../../com.pubnub.api.retry/-retry-configuration/-none/index.md). | | ||
| | [secretKey](secret-key.md) | [jvm]<br>abstract val [secretKey](secret-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>The secret key from the admin panel (only required for modifying/revealing access permissions). | | ||
| | [subscribeKey](subscribe-key.md) | [jvm]<br>abstract val [subscribeKey](subscribe-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>The subscribe key from the admin panel. | | ||
| | [userId](user-id.md) | [jvm]<br>abstract val [userId](user-id.md): [UserId](../../../com.pubnub.api/-user-id/index.md)<br>The user ID that the PubNub client will use. | |
12 changes: 12 additions & 0 deletions
12
....api.v2/-base-p-n-configuration-override/-builder/non-subscribe-read-timeout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[nonSubscribeReadTimeout](non-subscribe-read-timeout.md) | ||
|
|
||
| # nonSubscribeReadTimeout | ||
|
|
||
| [jvm]\ | ||
| abstract val [nonSubscribeReadTimeout](non-subscribe-read-timeout.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | ||
|
|
||
| For non subscribe operations (publish, herenow, etc), This property relates to a read timeout that is applied from the moment the connection between a client and the server has been successfully established. It defines a maximum time of inactivity between two data packets when waiting for the server’s response. | ||
|
|
||
| The value is in seconds. | ||
|
|
||
| Defaults to 10. |
8 changes: 8 additions & 0 deletions
8
...-api/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/publish-key.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[publishKey](publish-key.md) | ||
|
|
||
| # publishKey | ||
|
|
||
| [jvm]\ | ||
| abstract val [publishKey](publish-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | ||
|
|
||
| The publish key from the admin panel (only required if publishing). |
10 changes: 10 additions & 0 deletions
10
....pubnub.api.v2/-base-p-n-configuration-override/-builder/retry-configuration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[retryConfiguration](retry-configuration.md) | ||
|
|
||
| # retryConfiguration | ||
|
|
||
| [jvm]\ | ||
| abstract val [retryConfiguration](retry-configuration.md): [RetryConfiguration](../../../com.pubnub.api.retry/-retry-configuration/index.md) | ||
|
|
||
| Retry configuration for requests. Defaults to [RetryConfiguration.None](../../../com.pubnub.api.retry/-retry-configuration/-none/index.md). | ||
|
|
||
| Use [RetryConfiguration.Linear](../../../com.pubnub.api.retry/-retry-configuration/-linear/index.md) to set retry with linear delay interval Use [RetryConfiguration.Exponential](../../../com.pubnub.api.retry/-retry-configuration/-exponential/index.md) to set retry with exponential delay interval Delay will valy from provided value by random value. |
10 changes: 10 additions & 0 deletions
10
...e-api/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/secret-key.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[secretKey](secret-key.md) | ||
|
|
||
| # secretKey | ||
|
|
||
| [jvm]\ | ||
| abstract val [secretKey](secret-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | ||
|
|
||
| The secret key from the admin panel (only required for modifying/revealing access permissions). | ||
|
|
||
| Keep away from Android. |
8 changes: 8 additions & 0 deletions
8
...pi/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/subscribe-key.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[subscribeKey](subscribe-key.md) | ||
|
|
||
| # subscribeKey | ||
|
|
||
| [jvm]\ | ||
| abstract val [subscribeKey](subscribe-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | ||
|
|
||
| The subscribe key from the admin panel. |
8 changes: 8 additions & 0 deletions
8
...core-api/com.pubnub.api.v2/-base-p-n-configuration-override/-builder/user-id.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //[pubnub-core-api](../../../../index.md)/[com.pubnub.api.v2](../../index.md)/[BasePNConfigurationOverride](../index.md)/[Builder](index.md)/[userId](user-id.md) | ||
|
|
||
| # userId | ||
|
|
||
| [jvm]\ | ||
| abstract val [userId](user-id.md): [UserId](../../../com.pubnub.api/-user-id/index.md) | ||
|
|
||
| The user ID that the PubNub client will use. |
17 changes: 17 additions & 0 deletions
17
...api/pubnub-core-api/com.pubnub.api.v2/-base-p-n-configuration-override/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| //[pubnub-core-api](../../../index.md)/[com.pubnub.api.v2](../index.md)/[BasePNConfigurationOverride](index.md) | ||
|
|
||
| # BasePNConfigurationOverride | ||
|
|
||
| interface [BasePNConfigurationOverride](index.md) | ||
|
|
||
| #### Inheritors | ||
|
|
||
| | | | ||
| |---| | ||
| | [BasePNConfiguration](../-base-p-n-configuration/index.md) | | ||
|
|
||
| ## Types | ||
|
|
||
| | Name | Summary | | ||
| |---|---| | ||
| | [Builder](-builder/index.md) | [jvm]<br>interface [Builder](-builder/index.md) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.