Skip to content

Commit 8e16874

Browse files
jguz-pubnubjguz-pubnub
committed
docs: Complete DocC documentation for all entity types
1 parent cee81de commit 8e16874

File tree

12 files changed

+167
-9
lines changed

12 files changed

+167
-9
lines changed

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/Channel.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535

3636
### Presence Management
3737

38-
- ``whoIsPresent()``
39-
- ``whoIsPresent(completion:)``
38+
- ``whoIsPresent(limit:offset:)``
39+
- ``whoIsPresent(limit:offset:completion:)``
4040
- ``isPresent(userId:)``
4141
- ``isPresent(userId:completion:)``
4242
- ``join(custom:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ChannelImpl.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535

3636
### Presence Management
3737

38-
- ``whoIsPresent()``
39-
- ``whoIsPresent(completion:)``
38+
- ``whoIsPresent(limit:offset:)``
39+
- ``whoIsPresent(limit:offset:completion:)``
4040
- ``isPresent(userId:)``
4141
- ``isPresent(userId:completion:)``
4242
- ``join(custom:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/Membership.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# ``PubNubSwiftChatSDK/Membership``
2+
3+
## Topics
4+
5+
### Receiving Updates
6+
7+
- ``streamUpdates()``
8+
- ``streamUpdates(callback:)``
9+
- ``streamUpdatesOn(memberships:)``
10+
- ``streamUpdatesOn(memberships:callback:)``
11+
12+
### Read Receipts
13+
14+
- ``setLastReadMessage(message:)``
15+
- ``setLastReadMessage(message:completion:)``
16+
- ``setLastReadMessageTimetoken(_:)``
17+
- ``setLastReadMessageTimetoken(_:completion:)``
18+
- ``getUnreadMessagesCount()``
19+
- ``getUnreadMessagesCount(completion:)``
20+
21+
### Updating Membership
22+
23+
- ``update(custom:)``
24+
- ``update(custom:completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/MembershipImpl.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# ``PubNubSwiftChatSDK/MembershipImpl``
2+
3+
## Topics
4+
5+
### Receiving Updates
6+
7+
- ``streamUpdates()``
8+
- ``streamUpdates(callback:)``
9+
- ``streamUpdatesOn(memberships:)``
10+
- ``streamUpdatesOn(memberships:callback:)``
11+
12+
### Read Receipts
13+
14+
- ``setLastReadMessage(message:)``
15+
- ``setLastReadMessage(message:completion:)``
16+
- ``setLastReadMessageTimetoken(_:)``
17+
- ``setLastReadMessageTimetoken(_:completion:)``
18+
- ``getUnreadMessagesCount()``
19+
- ``getUnreadMessagesCount(completion:)``
20+
21+
### Updating Membership
22+
23+
- ``update(custom:)``
24+
- ``update(custom:completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ThreadChannel.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ``PubNubSwiftChatSDK/ThreadChannel``
2+
3+
## Topics
4+
5+
### Pinning Messages to Parent Channel
6+
7+
- ``pinMessageToParentChannel(message:)``
8+
- ``pinMessageToParentChannel(message:completion:)``
9+
- ``unpinMessageFromParentChannel()``
10+
- ``unpinMessageFromParentChannel(completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ThreadChannelImpl.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ``PubNubSwiftChatSDK/ThreadChannelImpl``
2+
3+
## Topics
4+
5+
### Pinning Messages to Parent Channel
6+
7+
- ``pinMessageToParentChannel(message:)``
8+
- ``pinMessageToParentChannel(message:completion:)``
9+
- ``unpinMessageFromParentChannel()``
10+
- ``unpinMessageFromParentChannel(completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ThreadMessage.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ``PubNubSwiftChatSDK/ThreadMessage``
2+
3+
## Topics
4+
5+
### Pinning to Parent Channel
6+
7+
- ``pinToParentChannel()``
8+
- ``pinToParentChannel(completion:)``
9+
- ``unpinFromParentChannel()``
10+
- ``unpinFromParentChannel(completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ThreadMessageImpl.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ``PubNubSwiftChatSDK/ThreadMessageImpl``
2+
3+
## Topics
4+
5+
### Pinning to Parent Channel
6+
7+
- ``pinToParentChannel()``
8+
- ``pinToParentChannel(completion:)``
9+
- ``unpinFromParentChannel()``
10+
- ``unpinFromParentChannel(completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/User.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# ``PubNubSwiftChatSDK/User``
2+
3+
## Topics
4+
5+
### Receiving Updates
6+
7+
- ``streamUpdates()``
8+
- ``streamUpdates(callback:)``
9+
- ``streamUpdatesOn(users:)``
10+
- ``streamUpdatesOn(users:callback:)``
11+
12+
### Update and Delete a User
13+
14+
- ``update(name:externalId:profileUrl:email:custom:status:type:)``
15+
- ``update(name:externalId:profileUrl:email:custom:status:type:completion:)``
16+
- ``update(updateAction:)``
17+
- ``update(updateAction:completion:)``
18+
- ``delete(soft:)``
19+
- ``delete(soft:completion:)``
20+
21+
### Presence Management
22+
23+
- ``wherePresent()``
24+
- ``wherePresent(completion:)``
25+
- ``isPresentOn(channelId:)``
26+
- ``isPresentOn(channelId:completion:)``
27+
28+
### Memberships Management
29+
30+
- ``getMemberships(limit:page:filter:sort:)``
31+
- ``getMemberships(limit:page:filter:sort:completion:)``
32+
- ``isMemberOf(channelId:)``
33+
- ``isMemberOf(channelId:completion:)``
34+
- ``getMembership(channelId:)``
35+
- ``getMembership(channelId:completion:)``

‎PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/UserImpl.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# ``PubNubSwiftChatSDK/UserImpl``
2+
3+
## Topics
4+
5+
### Receiving Updates
6+
7+
- ``streamUpdates()``
8+
- ``streamUpdates(callback:)``
9+
- ``streamUpdatesOn(users:)``
10+
- ``streamUpdatesOn(users:callback:)``
11+
12+
### Update and Delete a User
13+
14+
- ``update(name:externalId:profileUrl:email:custom:status:type:)``
15+
- ``update(name:externalId:profileUrl:email:custom:status:type:completion:)``
16+
- ``update(updateAction:)``
17+
- ``update(updateAction:completion:)``
18+
- ``delete(soft:)``
19+
- ``delete(soft:completion:)``
20+
21+
### Presence Management
22+
23+
- ``wherePresent()``
24+
- ``wherePresent(completion:)``
25+
- ``isPresentOn(channelId:)``
26+
- ``isPresentOn(channelId:completion:)``
27+
28+
### Memberships Management
29+
30+
- ``getMemberships(limit:page:filter:sort:)``
31+
- ``getMemberships(limit:page:filter:sort:completion:)``
32+
- ``isMemberOf(channelId:)``
33+
- ``isMemberOf(channelId:completion:)``
34+
- ``getMembership(channelId:)``
35+
- ``getMembership(channelId:completion:)``

0 commit comments

Comments
 (0)