Appearance
stage.ref
ステージへの参照です。
プロパティ
admin
要認証エリアへのアクセスです。
authorized
type
boolean
操作ユーザーがセットされ、且つユーザーが認証されているかどうかです。
autoBroadcast
ステージに紐づく自動配信のオペレータです。
delivery
type
DeliveryOperator
ステージに紐づく送料のオペレータです。
DANGER
送料関連は未実装です
event
ステージに紐づくイベントのオペレータです。
payee
type
PayeeOperator →ステージに紐づく支払先のオペレータです。
product
ステージに紐づく物販のオペレータです。
room
type
RoomOperator →ステージに紐づく会議室のオペレータです。
ticket
type
TicketOperator →ステージに紐づくチケットのオペレータです。
tipping
ステージに紐づく投げ銭のオペレータです。
user
type
UserReference →type
null
SDK を操作しているユーザーです。
uuid
type
string
ステージの UUID です。
video
type
VideoOperator →ステージに紐づくビデオのオペレータです。
メソッド
getAuthorizedHeader()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| required | boolean | 未認証時にエラーとするか |
type
HedgehogAuthorizedRequestHeader
API との通信時に使用する認証ヘッダを取得します。SDK 内で API と通信する箇所で内部的に呼び出されます。
INFO
setUser()でセットされたユーザーの認証を用います。
使用方法
ts
const header = Hedgehog.stage.ref("ステージのUUID").getAuthorizedHeader();getName()
type
Promise<string>
ステージの名称を取得します。
使用方法
ts
const name = await Hedgehog.stage.ref("ステージのUUID").getName();getUserRoleForStage()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| user | UserReference | ユーザー |
type
Promise<UserType>
ユーザーのステージに対する権限を取得します。 ユーザーが指定されていない場合はsetUser()で設定したユーザーの、指定されている場合はそのユーザーの権限を取得します。
使用方法
ts
/* eslint-disable @typescript-eslint/no-unused-vars */
import { Hedgehog } from "@/sdk";
(async () => {
// #region setUser
Hedgehog.stage
.ref("ステージのUUID")
.setUser(Hedgehog.user.ref("メールアドレス"));
// #endregion setUser
})();
(async () => {
// #region getAuthorizedHeader
const header = Hedgehog.stage.ref("ステージのUUID").getAuthorizedHeader();
// #endregion getAuthorizedHeader
})();
(async () => {
// #region getUserRoleForStage
// setUser() でユーザーを設定した後で
const role = await Hedgehog.stage.ref("ステージのUUID").getUserRoleForStage();
// #endregion getRoleForStage
})();
(async () => {
// #region getName
const name = await Hedgehog.stage.ref("ステージのUUID").getName();
// #endregion getName
})();
setUser()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| user | ✓ | UserReference / null | 操作ユーザー |
type
StageReference →SDKを操作するユーザーを設定します。
使用方法
ts
Hedgehog.stage
.ref("ステージのUUID")
.setUser(Hedgehog.user.ref("メールアドレス"));