|
3777 | 3777 | Endpoint["Unknown"] = "UnknownEndpoint"; |
3778 | 3778 | /** |
3779 | 3779 | * The endpoints to send messages. |
| 3780 | + * |
| 3781 | + * This is related to the following functionality: |
| 3782 | + * - `publish` |
| 3783 | + * - `signal` |
| 3784 | + * - `publish file` |
| 3785 | + * - `fire` |
3780 | 3786 | */ |
3781 | 3787 | Endpoint["MessageSend"] = "MessageSendEndpoint"; |
3782 | 3788 | /** |
3783 | 3789 | * The endpoint for real-time update retrieval. |
| 3790 | + * |
| 3791 | + * This is related to the following functionality: |
| 3792 | + * - `subscribe` |
3784 | 3793 | */ |
3785 | 3794 | Endpoint["Subscribe"] = "SubscribeEndpoint"; |
3786 | 3795 | /** |
3787 | 3796 | * The endpoint to access and manage `user_id` presence and fetch channel presence information. |
| 3797 | + * |
| 3798 | + * This is related to the following functionality: |
| 3799 | + * - `get presence state` |
| 3800 | + * - `set presence state` |
| 3801 | + * - `here now` |
| 3802 | + * - `where now` |
| 3803 | + * - `heartbeat` |
3788 | 3804 | */ |
3789 | 3805 | Endpoint["Presence"] = "PresenceEndpoint"; |
3790 | 3806 | /** |
3791 | 3807 | * The endpoint to access and manage files in channel-specific storage. |
| 3808 | + * |
| 3809 | + * This is related to the following functionality: |
| 3810 | + * - `send file` |
| 3811 | + * - `download file` |
| 3812 | + * - `list files` |
| 3813 | + * - `delete file` |
3792 | 3814 | */ |
3793 | 3815 | Endpoint["Files"] = "FilesEndpoint"; |
3794 | 3816 | /** |
3795 | 3817 | * The endpoint to access and manage messages for a specific channel(s) in the persistent storage. |
| 3818 | + * |
| 3819 | + * This is related to the following functionality: |
| 3820 | + * - `fetch messages / message actions` |
| 3821 | + * - `delete messages` |
| 3822 | + * - `messages count` |
3796 | 3823 | */ |
3797 | 3824 | Endpoint["MessageStorage"] = "MessageStorageEndpoint"; |
3798 | 3825 | /** |
3799 | 3826 | * The endpoint to access and manage channel groups. |
| 3827 | + * |
| 3828 | + * This is related to the following functionality: |
| 3829 | + * - `add channels to group` |
| 3830 | + * - `list channels in group` |
| 3831 | + * - `remove channels from group` |
| 3832 | + * - `list channel groups` |
3800 | 3833 | */ |
3801 | 3834 | Endpoint["ChannelGroups"] = "ChannelGroupsEndpoint"; |
3802 | 3835 | /** |
3803 | 3836 | * The endpoint to access and manage device registration for channel push notifications. |
| 3837 | + * |
| 3838 | + * This is related to the following functionality: |
| 3839 | + * - `enable channels for push notifications` |
| 3840 | + * - `list push notification enabled channels` |
| 3841 | + * - `disable push notifications for channels` |
| 3842 | + * - `disable push notifications for all channels` |
3804 | 3843 | */ |
3805 | 3844 | Endpoint["DevicePushNotifications"] = "DevicePushNotificationsEndpoint"; |
3806 | 3845 | /** |
3807 | 3846 | * The endpoint to access and manage App Context objects. |
| 3847 | + * |
| 3848 | + * This is related to the following functionality: |
| 3849 | + * - `set UUID metadata` |
| 3850 | + * - `get UUID metadata` |
| 3851 | + * - `remove UUID metadata` |
| 3852 | + * - `get all UUID metadata` |
| 3853 | + * - `set Channel metadata` |
| 3854 | + * - `get Channel metadata` |
| 3855 | + * - `remove Channel metadata` |
| 3856 | + * - `get all Channel metadata` |
| 3857 | + * - `manage members` |
| 3858 | + * - `list members` |
| 3859 | + * - `manage memberships` |
| 3860 | + * - `list memberships` |
3808 | 3861 | */ |
3809 | 3862 | Endpoint["AppContext"] = "AppContextEndpoint"; |
3810 | 3863 | /** |
3811 | 3864 | * The endpoint to access and manage reactions for a specific message. |
| 3865 | + * |
| 3866 | + * This is related to the following functionality: |
| 3867 | + * - `add message action` |
| 3868 | + * - `get message actions` |
| 3869 | + * - `remove message action` |
3812 | 3870 | */ |
3813 | 3871 | Endpoint["MessageReactions"] = "MessageReactionsEndpoint"; |
3814 | 3872 | })(Endpoint || (Endpoint = {})); |
|
3817 | 3875 | * Failed request retry policy. |
3818 | 3876 | */ |
3819 | 3877 | class RetryPolicy { |
| 3878 | + static None() { |
| 3879 | + return { |
| 3880 | + shouldRetry(_request, _response, _errorCategory, _attempt) { |
| 3881 | + return false; |
| 3882 | + }, |
| 3883 | + getDelay(_attempt, _response) { |
| 3884 | + return -1; |
| 3885 | + }, |
| 3886 | + validate() { |
| 3887 | + return true; |
| 3888 | + }, |
| 3889 | + }; |
| 3890 | + } |
3820 | 3891 | static LinearRetryPolicy(configuration) { |
3821 | 3892 | var _a; |
3822 | 3893 | return { |
|
4138 | 4209 | return base.PubNubFile; |
4139 | 4210 | }, |
4140 | 4211 | get version() { |
4141 | | - return '9.5.0'; |
| 4212 | + return '9.5.1'; |
4142 | 4213 | }, |
4143 | 4214 | getVersion() { |
4144 | 4215 | return this.version; |
|
14648 | 14719 | * API call status category. |
14649 | 14720 | */ |
14650 | 14721 | PubNubCore.CATEGORIES = StatusCategory$1; |
| 14722 | + /** |
| 14723 | + * Enum with API endpoint groups which can be used with retry policy to set up exclusions (which shouldn't be |
| 14724 | + * retried). |
| 14725 | + */ |
| 14726 | + PubNubCore.Endpoint = Endpoint; |
14651 | 14727 | /** |
14652 | 14728 | * Exponential retry policy constructor. |
14653 | 14729 | */ |
|
14656 | 14732 | * Linear retry policy constructor. |
14657 | 14733 | */ |
14658 | 14734 | PubNubCore.LinearRetryPolicy = RetryPolicy.LinearRetryPolicy; |
| 14735 | + /** |
| 14736 | + * Disabled / inactive retry policy. |
| 14737 | + * |
| 14738 | + * **Note:** By default `ExponentialRetryPolicy` is set for subscribe requests and this one can be used to disable |
| 14739 | + * retry policy for all requests (setting `undefined` for retry configuration will set default policy). |
| 14740 | + */ |
| 14741 | + PubNubCore.NoneRetryPolicy = RetryPolicy.None; |
14659 | 14742 |
|
14660 | 14743 | /** |
14661 | 14744 | * Cbor decoder module. |
|
0 commit comments