Repository navigation
Expand file tree
/
Copy pathconfig.d.ts
More file actions
155 lines (150 loc) · 4.95 KB
/
Copy pathconfig.d.ts
File metadata and controls
155 lines (150 loc) · 4.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
export type Config = Readonly<{
/**
* アプリ名
* 省略時、空文字列時は`'traQ'`
*/
name?: string
/**
* Firebase用設定
* 省略時は通知機能を無効化
* https://firebase.google.com/docs/web/learn-more#config-object
*/
firebase?: Readonly<{
apiKey: string
appId: string
projectId: string
messagingSenderId: string
/**
* https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm
*/
vapidKey: string
}>
/**
* Qall機能を有効化するかどうか
* 省略時は無効化
*/
enableQall?: boolean
/**
* 検索機能を有効化するかどうか
* 省略時は無効化
*/
enableSearch?: boolean
/**
* アクティビティとエラーの送信先。省略時は収集しない。
* HTTPS または localhost などの安全なコンテキストでのみ利用可能。
*/
telemetry?: Readonly<{
/** 同一オリジンの HTTP(S) URL。相対 URL も指定可能 */
endpoint: string
/** 収集対象のホスト名。省略時はすべて、空配列なら収集しない */
hosts?: readonly string[]
/** 省略時は location.hostname */
environment?: string
}>
/**
* アプリ一覧に表示されるサービス
* 省略時はアプリ一覧ボタンを非表示にする
*/
services?: ReadonlyArray<{
/**
* 表示名
*/
label: string
/**
* `/img/services`からのアイコンへのパス(拡張子含む)
*/
iconPath: string
/**
* リンク先
*/
appLink: string
}>
/**
* OGPが表示されないようにするホスト
* 省略時は、すべてのホストのOGPを表示する
*/
ogpIgnoreHostNames?: readonly string[]
/**
* Wikiのユーザーページへのリンク
* undefinedにするとリンクが表示されない
*/
wikiPageOrigin?: string
/**
* ブログの投稿者ページへのリンク
* undefinedにするとリンクが表示されない
*/
blogPagePrefix?: string
/**
* 外部認証が有効の場合の設定
* 省略時は各種リンクが表示されない
*/
auth?: Readonly<{
/**
* ログイン画面での「パスワードを忘れた」のリンクのリンク先
*/
resetLink: string
/**
* 設定画面での「パスワードは~から可能です」のリンクのリンク先
*/
changeLink: string
/**
* 設定画面での「パスワードは~から可能です」の「~」の表示
*/
changeName: string
}>
/**
* チャンネル変更権限をもっていないユーザーでも
* チャンネル作成時に親チャンネルとしてrootを選択可能にする
* サーバーでははじいていないので、APIをたたけば誰でも可能
*/
isRootChannelSelectableAsParentChannel: boolean
/**
* 大きなファイルサイズのファイルを送信した際に表示される補足メッセージ
* `%s`の部分には「画像」または「ファイル」が入る
* @default '大きい%sの共有には別のサービスを利用してください。'
*/
tooLargeFileMessage?: string
/**
* iframe埋め込みウィジェットのコピーボタンの有効化
* 同じドメインの/widget/以下にtraQ-Widgetがデプロイされていることが前提
* 省略時は`false`
*/
showWidgetCopyButton?: boolean
/**
* 通知でのインライン返信を無効化するチャンネル
* 省略時はどのチャンネルも無効化しない
* @example ['#general', '#random']
*/
inlineReplyDisableChannels?: string[]
/**
* iOSアプリの廃止告知バナーに載せるPWAについてのリンク
* 省略時はリンクへの誘導テキストが載らない
*/
iosPwaInfoLink?: string
/**
* デフォルトチャンネルのチャンネル ID
* 起動時チャンネルが 設定されていない / 見つからない / 解決できない 場合に使用される
* 配列を与えた場合は先頭から優先して考慮され,最初に見つかったチャンネルが使用される
* 省略時は fallbackChannelPath にフォールバックする
*/
defaultChannelId?: string | string[]
/**
* どうしてもパスを解決できなかった場合など,最後に使用されるフォールバック (ID ではなくパス)
* `defaultChannelId` が設定されている場合はそちらが優先される
* 省略時は空文字列(チャンネルが選択されていない状態)
*
* @example 'general'
*/
fallbackChannelPath?: string
/**
* 共有リンクなどに使うオリジン。メタ情報より優先
* 省略時・空文字列時はメタ情報を使い、利用できない場合は `location.origin`
* 開発時は設定済みの `DEV_SERVER` を優先
*
* @example 'https://q.trap.jp'
*/
backendOrigin?: string
}>
declare global {
var traQConfig: Config
}