zhucebuliaopx / lua-resty-agoradynamickey

an optional lua resty lib AgoraDynamicKey

Name

lua-resty-agoradynamickey: an optional lua resty lib AgoraDynamicKey

Installation

Just place agoradynamickey directory somewhere in your package.path, under resty directory.

depend

lua-struct

you can install with luarocks, or just place the struct.lua in your package.path,under resty directory.

luarocks install lua-struct

Table of Contents

• Name
• Installation
  • depend
• Table of Contents
• Synopsis
• Methods
  • new
  • rtc_token_builder
  • rtm_token_builder
• See Also

Synopsis

    # you do not need the following line if you are using
    # the ngx_openresty bundle:
    lua_package_path "/path/to/lua-resty-mysql/lib/?.lua;;";

    server {
        location /test {
            content_by_lua '
                local access_token = require "resty.agoradynamickey.access_token"
                local app_id = "test_app_id"
                local app_certificate = "test_app_certificate"
                local channel_name = "test_channel_name"
                local uid = 123456
                local expire_ts = 1598881347
                local salt = 1
                local ts = 1598181347
                local expected = "006test_app_idIAA2vi1+SRyDQKacsKuTrwXuIM1Jbh1Nsk5dy2ipAH3t/Eg98e5h03IJEAABAAAA409CXwEAAQBD/kxf" 

                local token = access_token.new(app_id, app_certificate, channel_name, uid)
                token.salt = salt
                token.ts = ts
                token.messages[token.kJoinChannel] = expire_ts
                local result = token:build()
                ngx.say(result == expected)  -- true
            ';
        }
    }

Methods

new

syntax: token = access_token.new(options)

Creates a access_token object. The options argument is a Lua table holding the following keys:

• app_id

  the apple id.

• app_certificate

  the app certificate for your app account.

• channel_name

  the channel name you define in agora.

• user_account

  the user_account(number/string). Back to TOC

rtc_token_builder

syntax: token = rtm_token_builder.build_token_with_uid(options)

Creates a rtc access token to channel. The options argument is a Lua table holding the following keys:

• app_id

  the apple id.

• app_certificate

  the app certificate for your app account.

• channel_name

  the channel name you define in agora.

• user_account

  the user_account(number/string).

• role

  the user role you define in agora.

• privilege_expired_ts

  the user token expire ts. Back to TOC

rtm_token_builder

syntax: token = rtm_token_builder.build_token_with_uid(options)

Creates a rtc access token to channel. The options argument is a Lua table holding the following keys:

• app_id

  the apple id.

• app_certificate

  the app certificate for your app account.

• channel_name

  the channel name you define in agora.

• user_account

  the user_account(number/string).

• role

  the user role you define in agora.

• privilege_expired_ts

  the user token expire ts. Back to TOC

See Also

• the lua-struct library
• the AgoraIO library

Back to TOC