agora-token 2.0.4 → 2.0.6

package/src/ApaasTokenBuilder.js

@@ -16,7 +16,9 @@ class ApaasTokenBuilder {
      * @param userUuid          The user's id, must be unique.
      * @param role              The user's role.
      * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user room token.
      */
     static buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire) {
@@ -45,7 +47,9 @@ class ApaasTokenBuilder {
      *                          the Agora Dashboard. See Get an App Certificate.
      * @param userUuid          The user's id, must be unique.
      * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user token.
      */
     static buildUserToken(appId, appCertificate, userUuid, expire) {
@@ -64,7 +68,9 @@ class ApaasTokenBuilder {
      * @param appCertificate Certificate of the application that you registered in
      *                       the Agora Dashboard. See Get an App Certificate.
      * @param expire         represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                       Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                       Agora Service within 10 minutes after the token is generated, set expire as
+     *                       600(seconds). This value is the whole token expiration and the service privilege
+     *                       expiration. The whole token is invalid after this time.
      * @return The app token.
      */
     static buildAppToken(appId, appCertificate, expire) {

package/src/ChatTokenBuilder.js

@@ -11,7 +11,9 @@ class ChatTokenBuilder {
      * the Agora Dashboard. See Get an App Certificate.
      * @param userUuid The user's id, must be unique.
      * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The Chat User token.
      */
     static buildUserToken(appId, appCertificate, userUuid, expire) {
@@ -30,7 +32,9 @@ class ChatTokenBuilder {
      * @param appCertificate Certificate of the application that you registered in
      * the Agora Dashboard. See Get an App Certificate.
      * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The Chat App token.
      */
     static buildAppToken(appId, appCertificate, expire) {

package/src/ConvoAITokenBuilder.js

@@ -0,0 +1,68 @@
+const AccessToken = require('../src/AccessToken2').AccessToken2
+const ServiceConvoAI = require('../src/AccessToken2').ServiceConvoAI
+const ServiceRtc = require('../src/AccessToken2').ServiceRtc
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
+const Role = require('../src/RtcTokenBuilder2').Role
+
+class ConvoAITokenBuilder {
+    /**
+     * Builds a Token007 that carries RTC, RTM, and ConvoAI services.
+     * @param {*} appId The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format.
+     * @param {*} rtcAccount The RTC user's account, max length is 255 bytes.
+     * @param {*} rtcRole Role.PUBLISHER for a broadcaster or Role.SUBSCRIBER for an audience member.
+     * @param {*} rtcTokenExpire Represented by the number of seconds elapsed since now. This is the whole
+     * token expiration. The whole token is invalid after this time, even if a privilege expiration time is
+     * later.
+     * @param {*} joinChannelPrivilegeExpire Represented by the number of seconds elapsed since now. This
+     * value must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubAudioPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubVideoPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubDataStreamPrivilegeExpire Represented by the number of seconds elapsed since now. This
+     * value must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} rtmUserId The RTM user's account, max length is 255 bytes.
+     * @param {*} rtmTokenExpire Represented by the number of seconds elapsed since now. This value must not
+     * exceed rtcTokenExpire; otherwise, the RTM login privilege is limited by the token expiration time.
+     * @return The RTC, RTM, and ConvoAI token.
+     */
+    static buildToken(
+        appId,
+        appCertificate,
+        channelName,
+        rtcAccount,
+        rtcRole,
+        rtcTokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire,
+        rtmUserId,
+        rtmTokenExpire
+    ) {
+        const token = new AccessToken(appId, appCertificate, 0, rtcTokenExpire)
+
+        const serviceRtc = new ServiceRtc(channelName, rtcAccount)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, joinChannelPrivilegeExpire)
+        if (rtcRole === Role.PUBLISHER) {
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, pubAudioPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, pubVideoPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, pubDataStreamPrivilegeExpire)
+        }
+        token.add_service(serviceRtc)
+
+        const serviceRtm = new ServiceRtm(rtmUserId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, rtmTokenExpire)
+        token.add_service(serviceRtm)
+
+        token.add_service(new ServiceConvoAI())
+
+        return token.build()
+    }
+}
+
+module.exports = {
+    ConvoAITokenBuilder
+}

package/src/EducationTokenBuilder.js

@@ -16,7 +16,9 @@ class EducationTokenBuilder {
      * @param userUuid          The user's id, must be unique.
      * @param role              The user's role.
      * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user room token.
      */
     static buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire) {
@@ -45,7 +47,9 @@ class EducationTokenBuilder {
      *                          the Agora Dashboard. See Get an App Certificate.
      * @param userUuid          The user's id, must be unique.
      * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user token.
      */
     static buildUserToken(appId, appCertificate, userUuid, expire) {
@@ -64,7 +68,9 @@ class EducationTokenBuilder {
      * @param appCertificate Certificate of the application that you registered in
      *                       the Agora Dashboard. See Get an App Certificate.
      * @param expire         represented by the number of seconds elapsed since now. If, for example, you want to access the
-     *                       Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     *                       Agora Service within 10 minutes after the token is generated, set expire as
+     *                       600(seconds). This value is the whole token expiration and the service privilege
+     *                       expiration. The whole token is invalid after this time.
      * @return The app token.
      */
     static buildAppToken(appId, appCertificate, expire) {

package/src/FpaTokenBuilder.js

@@ -8,7 +8,7 @@ class FpaTokenBuilder {
      * Agora Dashboard if it is missing from your kit. See Get an App ID.
      * @param appCertificate Certificate of the application that you registered in
      * the Agora Dashboard. See Get an App Certificate.
-     * @return The FPA token.
+     * @return The FPA token. The token expires 24 hours after generation.
      */
     static buildToken(appId, appCertificate) {
         let token = new AccessToken(appId, appCertificate, 0, 24 * 3600)

package/src/RtcTokenBuilder2.js

@@ -36,8 +36,13 @@ class RtcTokenBuilder {
      * @param {*} role See #userRole.
      * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
      * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} tokenExpire epresented by the number of seconds elapsed since now. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds)
-     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     static buildTokenWithUid(appId, appCertificate, channelName, uid, role, tokenExpire, privilegeExpire = 0) {
@@ -66,8 +71,13 @@ class RtcTokenBuilder {
      * @param {*} role See #userRole.
      * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
      * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} tokenExpire epresented by the number of seconds elapsed since now. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds)
-     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     static buildTokenWithUserAccount(
@@ -128,15 +138,25 @@ class RtcTokenBuilder {
      * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
      * @param uid The user ID. A 32-bit unsigned integer with a value range from 1 to (2^32 - 1). It must be unique. Set uid as 0, if you do not want to authenticate the user ID, that is, any uid from the app client can join the channel.
      * @param tokenExpire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds). This is
+     * the whole token expiration. The whole token is invalid after this time, even if a privilege expiration
+     * time is later.
      * @param joinChannelPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set joinChannelPrivilegeExpire as 600(seconds).
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set
+     * joinChannelPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @param pubAudioPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @param pubVideoPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @param pubDataStreamPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish data stream privilege for 10 minutes, set pubDataStreamPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set
+     * pubDataStreamPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token
      */
     static buildTokenWithUidAndPrivilege(
@@ -198,15 +218,25 @@ class RtcTokenBuilder {
      * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
      * @param userAccount The user account.
      * @param tokenExpire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds). This is
+     * the whole token expiration. The whole token is invalid after this time, even if a privilege expiration
+     * time is later.
      * @param joinChannelPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set joinChannelPrivilegeExpire as 600(seconds).
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set
+     * joinChannelPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @param pubAudioPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @param pubVideoPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @param pubDataStreamPrivilegeExpire represented by the number of seconds elapsed since now.
-     * If, for example, you want to enable publish data stream privilege for 10 minutes, set pubDataStreamPrivilegeExpire as 600(seconds).
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set
+     * pubDataStreamPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     static BuildTokenWithUserAccountAndPrivilege(
@@ -246,8 +276,13 @@ class RtcTokenBuilder {
      * @param {*} role See #userRole.
      * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
      * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} tokenExpire epresented by the number of seconds elapsed since now. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds)
-     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to access the Agora Service within 10 minutes after the token is generated, set tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC and RTM Token.
      */
     static buildTokenWithRtm(appId, appCertificate, channelName, account, role, tokenExpire, privilegeExpire = 0) {
@@ -268,6 +303,79 @@ class RtcTokenBuilder {
 
         return token.build()
     }
+
+    /**
+     * Build an RTC and RTM token with account.
+     * @param {*} appId  The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
+     * - The 26 lowercase English letters: a to z.
+     * - The 26 uppercase English letters: A to Z.
+     * - The 10 digits: 0 to 9.
+     * - The space.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param {*} rtcAccount The RTC user's account, max length is 255 Bytes.
+     * @param {*} rtcRole See #userRole.
+     * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
+     * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
+     * @param {*} rtcTokenExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to access the Agora Service within 10 minutes after the token is generated, set rtcTokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} joinChannelPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set
+     * joinChannelPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubAudioPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
+     * @param {*} pubVideoPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
+     * @param {*} pubDataStreamPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set
+     * pubDataStreamPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
+     * @param {*} rtmUserId: The RTM user's account, max length is 255 Bytes.
+     * @param {*} rtmTokenExpire: represented by the number of seconds elapsed since now. If, for example,
+     * you want to access the Agora Service within 10 minutes after the token is generated, set rtmTokenExpire
+     * as 600(seconds). This value must not exceed the RTC token expiration value; otherwise, the RTM login
+     * privilege is limited by the token expiration time.
+     * * @return The RTC and RTM Token.
+     */
+    static buildTokenWithRtm2(
+        appId,
+        appCertificate,
+        channelName,
+        rtcAccount,
+        rtcRole,
+        rtcTokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire,
+        rtmUserId,
+        rtmTokenExpire
+    ) {
+        let token = new AccessToken(appId, appCertificate, 0, rtcTokenExpire)
+
+        let serviceRtc = new ServiceRtc(channelName, rtcAccount)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, joinChannelPrivilegeExpire)
+        if (rtcRole == Role.PUBLISHER) {
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, pubAudioPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, pubVideoPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, pubDataStreamPrivilegeExpire)
+        }
+        token.add_service(serviceRtc)
+
+        let serviceRtm = new ServiceRtm(rtmUserId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, rtmTokenExpire)
+        token.add_service(serviceRtm)
+
+        return token.build()
+    }
 }
 
 module.exports.RtcTokenBuilder = RtcTokenBuilder

package/src/RtmTokenBuilder2.js

@@ -1,5 +1,6 @@
 const AccessToken = require('../src/AccessToken2').AccessToken2
 const ServiceRtm = require('../src/AccessToken2').ServiceRtm
+const ServiceRtm2 = require('../src/AccessToken2').ServiceRtm2
 
 class RtmTokenBuilder {
     /**
@@ -11,7 +12,9 @@ class RtmTokenBuilder {
      * the Agora Dashboard. See Get an App Certificate.
      * @param userId The user's account, max length is 64 Bytes.
      * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The RTM token.
      */
     static buildToken(appId, appCertificate, userId, expire) {
@@ -23,6 +26,27 @@ class RtmTokenBuilder {
 
         return token.build()
     }
+
+    /**
+     * Build an RTM2 token with resource-level permissions.
+     *
+     * This special interface requires Agora assistance for proper usage.
+     *
+     * @param appId The App ID issued to you by Agora.
+     * @param appCertificate Certificate of the application registered in the Agora Dashboard.
+     * @param userId The user's account, max length is 64 bytes.
+     * @param permissions The RTM2 resource-level permissions.
+     * @param expire The number of seconds from now before the token expires. This value is the whole token
+     * expiration and the service privilege expiration. The whole token is invalid after this time.
+     * @return The RTM2 token.
+     */
+    static buildTokenWithPermissions(appId, appCertificate, userId, permissions, expire) {
+        const token = new AccessToken(appId, appCertificate, null, expire)
+        const serviceRtm2 = new ServiceRtm2(userId, permissions)
+        serviceRtm2.add_privilege(ServiceRtm2.kPrivilegeLogin, expire)
+        token.add_service(serviceRtm2)
+        return token.build()
+    }
 }
 
 module.exports.RtmTokenBuilder = RtmTokenBuilder

package/src/SttTokenBuilder.js

@@ -0,0 +1,68 @@
+const AccessToken = require('../src/AccessToken2').AccessToken2
+const ServiceRtc = require('../src/AccessToken2').ServiceRtc
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
+const ServiceStt = require('../src/AccessToken2').ServiceStt
+const Role = require('../src/RtcTokenBuilder2').Role
+
+class SttTokenBuilder {
+    /**
+     * Builds a Token007 that carries RTC, RTM, and STT services.
+     * @param {*} appId The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format.
+     * @param {*} rtcAccount The RTC user's account, max length is 255 bytes.
+     * @param {*} rtcRole Role.PUBLISHER for a broadcaster or Role.SUBSCRIBER for an audience member.
+     * @param {*} rtcTokenExpire Represented by the number of seconds elapsed since now. This is the whole
+     * token expiration. The whole token is invalid after this time, even if a privilege expiration time is
+     * later.
+     * @param {*} joinChannelPrivilegeExpire Represented by the number of seconds elapsed since now. This
+     * value must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubAudioPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubVideoPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} pubDataStreamPrivilegeExpire Represented by the number of seconds elapsed since now. This
+     * value must not exceed rtcTokenExpire; otherwise, the privilege is limited by the token expiration time.
+     * @param {*} rtmUserId The RTM user's account, max length is 255 bytes.
+     * @param {*} rtmTokenExpire Represented by the number of seconds elapsed since now. This value must not
+     * exceed rtcTokenExpire; otherwise, the RTM login privilege is limited by the token expiration time.
+     * @return The RTC, RTM, and STT token.
+     */
+    static buildToken(
+        appId,
+        appCertificate,
+        channelName,
+        rtcAccount,
+        rtcRole,
+        rtcTokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire,
+        rtmUserId,
+        rtmTokenExpire
+    ) {
+        const token = new AccessToken(appId, appCertificate, 0, rtcTokenExpire)
+
+        const serviceRtc = new ServiceRtc(channelName, rtcAccount)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, joinChannelPrivilegeExpire)
+        if (rtcRole === Role.PUBLISHER) {
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, pubAudioPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, pubVideoPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, pubDataStreamPrivilegeExpire)
+        }
+        token.add_service(serviceRtc)
+
+        const serviceRtm = new ServiceRtm(rtmUserId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, rtmTokenExpire)
+        token.add_service(serviceRtm)
+
+        token.add_service(new ServiceStt())
+
+        return token.build()
+    }
+}
+
+module.exports = {
+    SttTokenBuilder
+}