agora-token 2.0.3 → 2.0.4

package/src/EducationTokenBuilder.js

@@ -1,9 +1,9 @@
+const md5 = require('md5')
+
 const AccessToken = require('../src/AccessToken2').AccessToken2
-const ServiceEducation = require('../src/AccessToken2').ServiceEducation
-const ServiceRtm = require('../src/AccessToken2').ServiceRtm
+const ServiceApaas = require('../src/AccessToken2').ServiceApaas
 const ServiceChat = require('../src/AccessToken2').ServiceChat
-const md5 = require("md5")
-
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
 
 class EducationTokenBuilder {
     /**
@@ -14,17 +14,17 @@ class EducationTokenBuilder {
      *                          the Agora Dashboard. See Get an App Certificate.
      * @param roomUuid          The room's id, must be unique.
      * @param userUuid          The user's id, must be unique.
-     * @param role              The user's role, such as 0(invisible), 1(teacher), 2(student), 3(assistant), 4(observer) etc.
+     * @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 expireTimestamp as 600(seconds).
-     * @return The education user room token.
+     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * @return The user room token.
      */
     static buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire) {
         let accessToken = new AccessToken(appId, appCertificate, 0, expire)
 
         let chatUserId = md5(userUuid)
-        let eduService = new ServiceEducation(roomUuid, userUuid, role)
-        accessToken.add_service(eduService)
+        let apaasService = new ServiceApaas(roomUuid, userUuid, role)
+        accessToken.add_service(apaasService)
 
         let rtmService = new ServiceRtm(userUuid)
         rtmService.add_privilege(ServiceRtm.kPrivilegeLogin, expire)
@@ -38,40 +38,40 @@ class EducationTokenBuilder {
     }
 
     /**
-     * build user individual token
+     * build user token
      * @param appId             The App ID issued to you by Agora. Apply for a new App ID from
      *                          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.
      * @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 expireTimestamp as 600(seconds).
-     * @return The education user token.
+     *                          Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * @return The user token.
      */
     static buildUserToken(appId, appCertificate, userUuid, expire) {
         let accessToken = new AccessToken(appId, appCertificate, 0, expire)
-        let eduService = new ServiceEducation("", userUuid)
-        eduService.add_privilege(ServiceEducation.PRIVILEGE_USER, expire)
-        accessToken.add_service(eduService)
+        let apaasService = new ServiceApaas('', userUuid)
+        apaasService.add_privilege(ServiceApaas.PRIVILEGE_USER, expire)
+        accessToken.add_service(apaasService)
 
         return accessToken.build()
     }
 
     /**
-     * build app global token
+     * build app token
      * @param appId          The App ID issued to you by Agora. Apply for a new App ID from
      *                       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.
      * @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 expireTimestamp as 600(seconds).
-     * @return The education global token.
+     *                       Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+     * @return The app token.
      */
     static buildAppToken(appId, appCertificate, expire) {
         let accessToken = new AccessToken(appId, appCertificate, 0, expire)
-        let eduService = new ServiceEducation()
-        eduService.add_privilege(ServiceEducation.PRIVILEGE_APP, expire)
-        accessToken.add_service(eduService)
+        let apaasService = new ServiceApaas()
+        apaasService.add_privilege(ServiceApaas.PRIVILEGE_APP, expire)
+        accessToken.add_service(apaasService)
 
         return accessToken.build()
     }

package/src/RtcTokenBuilder.js

@@ -5,11 +5,11 @@ const Role = {
     // DEPRECATED. Role::ATTENDEE has the same privileges as Role.PUBLISHER.
     ATTENDEE: 0,
 
-    // RECOMMENDED. Use this role for a voice/video call or a live broadcast, if your scenario does not require authentication for [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in).
+    // RECOMMENDED. Use this role for a voice/video call or a live broadcast, if your scenario does not require authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
     PUBLISHER: 1,
 
-    /* Only use this role if your scenario require authentication for [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in).
-     * @note In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role.SUBSCRIBER still has the same privileges as Role.PUBLISHER.
+    /* Only use this role if your scenario require authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
+     * @note 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.
      */
     SUBSCRIBER: 2,
 
@@ -18,58 +18,55 @@ const Role = {
 }
 
 class RtcTokenBuilder {
-
-   /**
-    * Builds an RTC token using an Integer uid.
-    * @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 {*} uid User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
-    * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-    * @param {*} privilegeExpiredTs  represented by the number of seconds elapsed since 1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current timestamp + 600 (seconds).
-    * @return The new Token.
-    */
+    /**
+     * Builds an RTC token using an Integer uid.
+     * @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 {*} uid User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
+     * @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 {*} privilegeExpiredTs  represented by the number of seconds elapsed since 1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current timestamp + 600 (seconds).
+     * @return The new Token.
+     */
     static buildTokenWithUid(appID, appCertificate, channelName, uid, role, privilegeExpiredTs) {
         return this.buildTokenWithAccount(appID, appCertificate, channelName, uid, role, privilegeExpiredTs)
     }
 
-   /**
-    * Builds an RTC token using an Integer uid.
-    * @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 {*} account The user account.
-    * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-    * @param {*} privilegeExpiredTs  represented by the number of seconds elapsed since 1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current timestamp + 600 (seconds).
-    * @return The new Token.
-    */
+    /**
+     * Builds an RTC 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 {*} account The user account.
+     * @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 {*} privilegeExpiredTs  represented by the number of seconds elapsed since 1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current timestamp + 600 (seconds).
+     * @return The new Token.
+     */
     static buildTokenWithAccount(appID, appCertificate, channelName, account, role, privilegeExpiredTs) {
         this.key = new AccessToken(appID, appCertificate, channelName, account)
         this.key.addPriviledge(Priviledges.kJoinChannel, privilegeExpiredTs)
-        if (role == Role.ATTENDEE ||
-            role == Role.PUBLISHER ||
-            role == Role.ADMIN) {
+        if (role == Role.ATTENDEE || role == Role.PUBLISHER || role == Role.ADMIN) {
             this.key.addPriviledge(Priviledges.kPublishAudioStream, privilegeExpiredTs)
             this.key.addPriviledge(Priviledges.kPublishVideoStream, privilegeExpiredTs)
             this.key.addPriviledge(Priviledges.kPublishDataStream, privilegeExpiredTs)
         }
-        return this.key.build();
+        return this.key.build()
     }
 }
 
-module.exports.RtcTokenBuilder = RtcTokenBuilder;
-module.exports.Role = Role;
+module.exports.RtcTokenBuilder = RtcTokenBuilder
+module.exports.Role = Role

package/src/RtcTokenBuilder2.js

@@ -1,12 +1,24 @@
 const AccessToken = require('../src/AccessToken2').AccessToken2
 const ServiceRtc = require('../src/AccessToken2').ServiceRtc
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
 
 const Role = {
-    // for live broadcaster
+    /**
+     * RECOMMENDED. Use this role for a voice/video call or a live broadcast, if
+     * your scenario does not require authentication for
+     * [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
+     */
     PUBLISHER: 1,
 
-    // default, for live audience
-    SUBSCRIBER: 2,
+    /**
+     * Only use this role if your scenario require authentication for
+     * [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
+     *
+     * @note In order for this role to take effect, please contact our support team
+     * to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber
+     * still has the same privileges as Role_Publisher.
+     */
+    SUBSCRIBER: 2
 }
 
 class RtcTokenBuilder {
@@ -23,16 +35,25 @@ class RtcTokenBuilder {
      * @param {*} uid User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
      * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} token_expire 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 token_expire as 600(seconds)
-     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).     * @return The new Token.
+     * - 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).
+     * @return The RTC Token.
      */
-    static buildTokenWithUid(appId, appCertificate, channelName, uid, role,  token_expire, privilege_expire = 0) {
-        return this.buildTokenWithUserAccount(appId, appCertificate, channelName, uid, role, token_expire, privilege_expire)
+    static buildTokenWithUid(appId, appCertificate, channelName, uid, role, tokenExpire, privilegeExpire = 0) {
+        return this.buildTokenWithUserAccount(
+            appId,
+            appCertificate,
+            channelName,
+            uid,
+            role,
+            tokenExpire,
+            privilegeExpire
+        )
     }
 
     /**
-     * Builds an RTC token using an Integer uid.
+     * Builds an RTC 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:
@@ -44,20 +65,28 @@ class RtcTokenBuilder {
      * @param {*} account The user account.
      * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} token_expire 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 token_expire as 600(seconds)
-     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
-     * @return The new Token.
+     * - 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).
+     * @return The RTC Token.
      */
-    static buildTokenWithUserAccount(appId, appCertificate, channelName, account, role, token_expire, privilege_expire = 0) {
-        let token = new AccessToken(appId, appCertificate, 0, token_expire)
+    static buildTokenWithUserAccount(
+        appId,
+        appCertificate,
+        channelName,
+        account,
+        role,
+        tokenExpire,
+        privilegeExpire = 0
+    ) {
+        let token = new AccessToken(appId, appCertificate, 0, tokenExpire)
 
         let serviceRtc = new ServiceRtc(channelName, account)
-        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, privilege_expire)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, privilegeExpire)
         if (role == Role.PUBLISHER) {
-            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, privilege_expire)
-            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, privilege_expire)
-            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, privilege_expire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, privilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, privilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, privilegeExpire)
         }
         token.add_service(serviceRtc)
 
@@ -99,29 +128,39 @@ 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 token_expire as 600(seconds).
-     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes.
-     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubAudioPrivilegeExpire as the current Unix timestamp.
-     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubVideoPrivilegeExpire as the current Unix timestamp.
-     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
-     * @return The new Token
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds).
+     * @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).
+     * @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).
+     * @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).
+     * @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).
+     * @return The RTC Token
      */
-    static buildTokenWithUidAndPrivilege(appId, appCertificate, channelName, uid,
-                                         tokenExpire, joinChannelPrivilegeExpire, pubAudioPrivilegeExpire,
-                                         pubVideoPrivilegeExpire, pubDataStreamPrivilegeExpire) {
-        return this.BuildTokenWithUserAccountAndPrivilege(appId, appCertificate, channelName, uid,
-            tokenExpire, joinChannelPrivilegeExpire, pubAudioPrivilegeExpire, pubVideoPrivilegeExpire, pubDataStreamPrivilegeExpire)
+    static buildTokenWithUidAndPrivilege(
+        appId,
+        appCertificate,
+        channelName,
+        uid,
+        tokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire
+    ) {
+        return this.BuildTokenWithUserAccountAndPrivilege(
+            appId,
+            appCertificate,
+            channelName,
+            uid,
+            tokenExpire,
+            joinChannelPrivilegeExpire,
+            pubAudioPrivilegeExpire,
+            pubVideoPrivilegeExpire,
+            pubDataStreamPrivilegeExpire
+        )
     }
 
     /**
@@ -159,27 +198,28 @@ 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 token_expire as 600(seconds).
-     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes.
-     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubAudioPrivilegeExpire as the current Unix timestamp.
-     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubVideoPrivilegeExpire as the current Unix timestamp.
-     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
-     * @return The new Token.
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds).
+     * @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).
+     * @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).
+     * @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).
+     * @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).
+     * @return The RTC Token.
      */
-    static BuildTokenWithUserAccountAndPrivilege(appId, appCertificate, channelName, account,
-                                                 tokenExpire, joinChannelPrivilegeExpire, pubAudioPrivilegeExpire,
-                                                 pubVideoPrivilegeExpire, pubDataStreamPrivilegeExpire) {
+    static BuildTokenWithUserAccountAndPrivilege(
+        appId,
+        appCertificate,
+        channelName,
+        account,
+        tokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire
+    ) {
         let token = new AccessToken(appId, appCertificate, 0, tokenExpire)
 
         let serviceRtc = new ServiceRtc(channelName, account)
@@ -191,6 +231,43 @@ 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 {*} account The user account.
+     * @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).
+     * @return The RTC and RTM Token.
+     */
+    static buildTokenWithRtm(appId, appCertificate, channelName, account, role, tokenExpire, privilegeExpire = 0) {
+        let token = new AccessToken(appId, appCertificate, 0, tokenExpire)
+
+        let serviceRtc = new ServiceRtc(channelName, account)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, privilegeExpire)
+        if (role == Role.PUBLISHER) {
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, privilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, privilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, privilegeExpire)
+        }
+        token.add_service(serviceRtc)
+
+        let serviceRtm = new ServiceRtm(account)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, tokenExpire)
+        token.add_service(serviceRtm)
+
+        return token.build()
+    }
 }
 
 module.exports.RtcTokenBuilder = RtcTokenBuilder

package/src/RtmTokenBuilder2.js

@@ -1,5 +1,5 @@
-const AccessToken = require("../src/AccessToken2").AccessToken2;
-const ServiceRtm = require("../src/AccessToken2").ServiceRtm;
+const AccessToken = require('../src/AccessToken2').AccessToken2
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
 
 class RtmTokenBuilder {
     /**
@@ -11,18 +11,18 @@ 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 expireTimestamp as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
      * @return The RTM token.
      */
     static buildToken(appId, appCertificate, userId, expire) {
-        let token = new AccessToken(appId, appCertificate, null, expire);
+        let token = new AccessToken(appId, appCertificate, null, expire)
 
-        let serviceRtm = new ServiceRtm(userId);
-        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, expire);
-        token.add_service(serviceRtm);
+        let serviceRtm = new ServiceRtm(userId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, expire)
+        token.add_service(serviceRtm)
 
-        return token.build();
+        return token.build()
     }
 }
 
-module.exports.RtmTokenBuilder = RtmTokenBuilder;
+module.exports.RtmTokenBuilder = RtmTokenBuilder