Subscription
WARNING
User must be logged in to call this method
Skapi database provides subscription access level in its table.
Records uploaded with subscription access level requires users to subscribe to the uploader to have access to the records.
You can let users upload records with the subscription access by setting the table.subscription to true:
Subscription can be useful when owner of the record wants to block certain users from accessing their subscription group records.
Lets assume user 'A' uploads a record in table 'Posts' with subscription access level.
// User 'A' uploads record in subscription table.
skapi.postRecord(null, {
table: {
name:'Posts',
access_group: 'authorized',
subscription: true
}})WARNING
Since user needs to login to subscribe to other users, the table.access_group cannot be set to public when uploading subscription records.
To allow other users to access the records that requires subscription, they must first subscribe to the uploader using the subscribe() method:
subscribe(option): Promise<string>
Lets assume user 'B' is logged in and, user 'B' is subscribing to user 'A'.
// User 'B' subscribes to user 'A' to subscription group 5.
skapi.subscribe({
user_id: 'user_id_of_user_A'
})Once the user 'B' has subscribed to user 'A', user 'B' will have access to the records in that requires subscription access.
// User 'B' can get records that requires subscription access of user 'A'
skapi.getRecords({
table: {
name: 'Posts',
access_group: 'authorized',
subscription: 'user_id_of_user_A'
}
}).then(response => {
console.log(response.list); // All posts user 'A' uploaded to table 'Posts' in subscription access level.
});TIP
Number of subscribers of the user will be tracked in UserPublic object that can be retrieved using the getUsers() method.
Warning
Do not rely on subscription access level as a security restriction. Anyone can subscribe to anybody to any subscription group. Consider subscription group as a additional layer of database query point that user needs additional action(subscribe) to have access.
The main purpose of subscription record is to give user access to block certain users from accessing their subscription group records.
The files uploaded to the records are not security restricted to the subscription group. Files uploaded to the records are only restricted to the user's access group.
Unsubscribing
WARNING
User must be logged in to call this method
Users can unsubscribe from the users they have subscribed to using the unsubscribe() method.
// User 'B'
skapi.unsubscribe({
user_id: 'user_id_of_user_A'
})For more detailed information on all the parameters and options available with the unsubscribe() method, please refer to the API Reference below:
unsubscribe(option): Promise<User | string>
WARNING
When unsubscribed, subscription information may need some time to be updated. (Usually almost immediate)
Blocking and Unblocking Subscribers
WARNING
User must be logged in to call this method
Main benifit of subscription access level is that users can block certain users from accessing their subscription level records. But as metioned above, subscription access level is not meant to be used as a security restriction.
Even when user has blocked certain users, they still have access to the files attached to the records since the file access level is not restricted to the subscription access.
Other than files, blocked users will not have access to any of the record data in the subscription access level.
Users can block certain users from their subscription groups. If the user is blocked from a subscription group, they will not have access to the records in that group.
To block a subscriber, user can call the blockSubscriber() method:
Blocking a Subscriber
// User 'A' blocks user 'B' from accessing all subscription group records.
skapi.blockSubscriber({
user_id: 'user_id_of_user_B'
}).then(res=>{
// User 'B' no longer have access to user A's subscription group records.
})For more detailed information on all the parameters and options available with the blockSubscriber() method, please refer to the API Reference below:
blockSubscriber(option): Promise<string>
Unblocking a Subscriber
// User 'A' unblocks user 'B' from all subscription group.
skapi.unblockSubscriber({
user_id: 'user_id_of_user_B'
}).then(res=>{
// User 'B' now has access to user A's subscription group records.
})For more detailed information on all the parameters and options available with the unblockSubscriber() method, please refer to the API Reference below:
unblockSubscriber(option): Promise<string>
Listing subscriptions
The getSubscriptions() method retrieves subscription information from the database.
params:
subscriber: The user ID of the subscriber.subscription: The user ID of the uploader.blocked: Set totrueto only retrieve blocked subscriptions.
Either the params.subscriber or params.subscription value must be provided.
Examples
/**
* Retrieve all subscription information where userB is the subscriber
*/
skapi.getSubscriptions({
subscriber: "userB_user_id"
}).then((response) => {
console.log(response.list);
});
/**
* Retrieve all subscription information where userA is being subscribed to
*/
skapi.getSubscriptions({
subscription: "userA_user_id"
}).then((response) => {
console.log(response.list);
});
/**
* Check if userB is subscribed to userA
*/
skapi.getSubscriptions({
subscriber: "userB_user_id",
subscription: "userA_user_id"
}).then((response) => {
console.log(response.list?.[0]);
});For more detailed information on all the parameters and options available with the getSubscriptions() method, please refer to the API Reference below: