ChannelAPI

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
createChannel	POST /channels	チャンネルを作成
editChannel	PATCH /channels/{channelId}	チャンネル情報を変更
editChannelSubscribers	PATCH /channels/{channelId}/subscribers	チャンネルの通知購読者を編集
editChannelTopic	PUT /channels/{channelId}/topic	チャンネルトピックを編集
getChannel	GET /channels/{channelId}	チャンネル情報を取得
getChannelBots_0	GET /channels/{channelId}/bots	チャンネル参加中のBOTのリストを取得
getChannelEvents	GET /channels/{channelId}/events	チャンネルイベントのリストを取得
getChannelPath	GET /channels/{channelId}/path	指定したチャンネルパスを取得
getChannelPins	GET /channels/{channelId}/pins	チャンネルピンのリストを取得
getChannelStats	GET /channels/{channelId}/stats	チャンネル統計情報を取得
getChannelSubscribers	GET /channels/{channelId}/subscribers	チャンネルの通知購読者のリストを取得
getChannelTopic	GET /channels/{channelId}/topic	チャンネルトピックを取得
getChannelViewers	GET /channels/{channelId}/viewers	チャンネル閲覧者リストを取得
getChannels	GET /channels	チャンネルリストを取得
getMessages	GET /channels/{channelId}/messages	チャンネルメッセージのリストを取得
getUserDMChannel_0	GET /users/{userId}/dm-channel	DMチャンネル情報を取得
postMessage_0	POST /channels/{channelId}/messages	チャンネルにメッセージを投稿
setChannelSubscribers	PUT /channels/{channelId}/subscribers	チャンネルの通知購読者を設定

createChannel

    open class func createChannel(postChannelRequest: PostChannelRequest? = nil, completion: @escaping (_ data: Channel?, _ error: Error?) -> Void)

チャンネルを作成

チャンネルを作成します。階層が6以上になるチャンネルは作成できません。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let postChannelRequest = PostChannelRequest(name: "name_example", parent: 123) // PostChannelRequest |  (optional)

// チャンネルを作成
ChannelAPI.createChannel(postChannelRequest: postChannelRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
postChannelRequest	PostChannelRequest		[optional]

Return type

Channel

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editChannel

    open class func editChannel(channelId: UUID, patchChannelRequest: PatchChannelRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

チャンネル情報を変更

指定したチャンネルの情報を変更します。変更には権限が必要です。ルートチャンネルに移動させる場合は、parentに00000000-0000-0000-0000-000000000000を指定してください。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let patchChannelRequest = PatchChannelRequest(name: "name_example", archived: false, force: false, parent: 123) // PatchChannelRequest |  (optional)

// チャンネル情報を変更
ChannelAPI.editChannel(channelId: channelId, patchChannelRequest: patchChannelRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
patchChannelRequest	PatchChannelRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editChannelSubscribers

    open class func editChannelSubscribers(channelId: UUID, patchChannelSubscribersRequest: PatchChannelSubscribersRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

チャンネルの通知購読者を編集

指定したチャンネルの通知購読者を編集します。リクエストに含めなかったユーザーの通知購読状態は変更しません。また、存在しないユーザーを指定した場合は無視されます。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let patchChannelSubscribersRequest = PatchChannelSubscribersRequest(on: [123], off: [123]) // PatchChannelSubscribersRequest |  (optional)

// チャンネルの通知購読者を編集
ChannelAPI.editChannelSubscribers(channelId: channelId, patchChannelSubscribersRequest: patchChannelSubscribersRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
patchChannelSubscribersRequest	PatchChannelSubscribersRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editChannelTopic

    open class func editChannelTopic(channelId: UUID, putChannelTopicRequest: PutChannelTopicRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

チャンネルトピックを編集

指定したチャンネルのトピックを編集します。アーカイブされているチャンネルのトピックは編集できません。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let putChannelTopicRequest = PutChannelTopicRequest(topic: "topic_example") // PutChannelTopicRequest |  (optional)

// チャンネルトピックを編集
ChannelAPI.editChannelTopic(channelId: channelId, putChannelTopicRequest: putChannelTopicRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
putChannelTopicRequest	PutChannelTopicRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannel

    open class func getChannel(channelId: UUID, completion: @escaping (_ data: Channel?, _ error: Error?) -> Void)

チャンネル情報を取得

指定したチャンネルの情報を取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネル情報を取得
ChannelAPI.getChannel(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

Channel

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelBots_0

    open class func getChannelBots_0(channelId: UUID, completion: @escaping (_ data: [BotUser]?, _ error: Error?) -> Void)

チャンネル参加中のBOTのリストを取得

指定したチャンネルに参加しているBOTのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネル参加中のBOTのリストを取得
ChannelAPI.getChannelBots_0(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

[BotUser]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelEvents

    open class func getChannelEvents(channelId: UUID, limit: Int? = nil, offset: Int? = nil, since: Date? = nil, until: Date? = nil, inclusive: Bool? = nil, order: Order_getChannelEvents? = nil, completion: @escaping (_ data: [ChannelEvent]?, _ error: Error?) -> Void)

チャンネルイベントのリストを取得

指定したチャンネルのイベントリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let limit = 987 // Int | 取得する件数 (optional)
let offset = 987 // Int | 取得するオフセット (optional) (default to 0)
let since = Date() // Date | 取得する時間範囲の開始日時 (optional) (default to Date(timeIntervalSince1970: -62167219200000000.0 / 1_000_000))
let until = Date() // Date | 取得する時間範囲の終了日時 (optional)
let inclusive = true // Bool | 範囲の端を含めるかどうか (optional) (default to false)
let order = "order_example" // String | 昇順か降順か (optional) (default to .desc)

// チャンネルイベントのリストを取得
ChannelAPI.getChannelEvents(channelId: channelId, limit: limit, offset: offset, since: since, until: until, inclusive: inclusive, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
limit	Int	取得する件数	[optional]
offset	Int	取得するオフセット	[optional] [default to 0]
since	Date	取得する時間範囲の開始日時	[optional] [default to Date(timeIntervalSince1970: -62167219200000000.0 / 1_000_000)]
until	Date	取得する時間範囲の終了日時	[optional]
inclusive	Bool	範囲の端を含めるかどうか	[optional] [default to false]
order	String	昇順か降順か	[optional] [default to .desc]

Return type

[ChannelEvent]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelPath

    open class func getChannelPath(channelId: UUID, completion: @escaping (_ data: ChannelPath?, _ error: Error?) -> Void)

指定したチャンネルパスを取得

指定したチャンネルのパスを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// 指定したチャンネルパスを取得
ChannelAPI.getChannelPath(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

ChannelPath

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelPins

    open class func getChannelPins(channelId: UUID, completion: @escaping (_ data: [Pin]?, _ error: Error?) -> Void)

チャンネルピンのリストを取得

指定したチャンネルにピン留めされているピンメッセージのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネルピンのリストを取得
ChannelAPI.getChannelPins(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

[Pin]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelStats

    open class func getChannelStats(channelId: UUID, completion: @escaping (_ data: ChannelStats?, _ error: Error?) -> Void)

チャンネル統計情報を取得

指定したチャンネルの統計情報を取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネル統計情報を取得
ChannelAPI.getChannelStats(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

ChannelStats

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelSubscribers

    open class func getChannelSubscribers(channelId: UUID, completion: @escaping (_ data: [UUID]?, _ error: Error?) -> Void)

チャンネルの通知購読者のリストを取得

指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネルの通知購読者のリストを取得
ChannelAPI.getChannelSubscribers(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

[UUID]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelTopic

    open class func getChannelTopic(channelId: UUID, completion: @escaping (_ data: ChannelTopic?, _ error: Error?) -> Void)

チャンネルトピックを取得

指定したチャンネルのトピックを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネルトピックを取得
ChannelAPI.getChannelTopic(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

ChannelTopic

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannelViewers

    open class func getChannelViewers(channelId: UUID, completion: @escaping (_ data: [ChannelViewer]?, _ error: Error?) -> Void)

チャンネル閲覧者リストを取得

指定したチャンネルの閲覧者のリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID

// チャンネル閲覧者リストを取得
ChannelAPI.getChannelViewers(channelId: channelId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID

Return type

[ChannelViewer]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChannels

    open class func getChannels(includeDm: Bool? = nil, path: String? = nil, completion: @escaping (_ data: ChannelList?, _ error: Error?) -> Void)

チャンネルリストを取得

チャンネルのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let includeDm = true // Bool | ダイレクトメッセージチャンネルをレスポンスに含めるかどうか (optional) (default to false)
let path = "path_example" // String | パスが一致するチャンネルのみを取得する (optional)

// チャンネルリストを取得
ChannelAPI.getChannels(includeDm: includeDm, path: path) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
includeDm	Bool	ダイレクトメッセージチャンネルをレスポンスに含めるかどうか	[optional] [default to false]
path	String	パスが一致するチャンネルのみを取得する	[optional]

Return type

ChannelList

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMessages

    open class func getMessages(channelId: UUID, limit: Int? = nil, offset: Int? = nil, since: Date? = nil, until: Date? = nil, inclusive: Bool? = nil, order: Order_getMessages? = nil, completion: @escaping (_ data: [Message]?, _ error: Error?) -> Void)

チャンネルメッセージのリストを取得

指定したチャンネルのメッセージのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let limit = 987 // Int | 取得する件数 (optional)
let offset = 987 // Int | 取得するオフセット (optional) (default to 0)
let since = Date() // Date | 取得する時間範囲の開始日時 (optional) (default to Date(timeIntervalSince1970: -62167219200000000.0 / 1_000_000))
let until = Date() // Date | 取得する時間範囲の終了日時 (optional)
let inclusive = true // Bool | 範囲の端を含めるかどうか (optional) (default to false)
let order = "order_example" // String | 昇順か降順か (optional) (default to .desc)

// チャンネルメッセージのリストを取得
ChannelAPI.getMessages(channelId: channelId, limit: limit, offset: offset, since: since, until: until, inclusive: inclusive, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
limit	Int	取得する件数	[optional]
offset	Int	取得するオフセット	[optional] [default to 0]
since	Date	取得する時間範囲の開始日時	[optional] [default to Date(timeIntervalSince1970: -62167219200000000.0 / 1_000_000)]
until	Date	取得する時間範囲の終了日時	[optional]
inclusive	Bool	範囲の端を含めるかどうか	[optional] [default to false]
order	String	昇順か降順か	[optional] [default to .desc]

Return type

[Message]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserDMChannel_0

    open class func getUserDMChannel_0(userId: UUID, completion: @escaping (_ data: DMChannel?, _ error: Error?) -> Void)

DMチャンネル情報を取得

指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let userId = 987 // UUID | 

// DMチャンネル情報を取得
ChannelAPI.getUserDMChannel_0(userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	UUID

Return type

DMChannel

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postMessage_0

    open class func postMessage_0(channelId: UUID, postMessageRequest: PostMessageRequest? = nil, completion: @escaping (_ data: Message?, _ error: Error?) -> Void)

チャンネルにメッセージを投稿

指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。アーカイブされているチャンネルに投稿することはできません。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let postMessageRequest = PostMessageRequest(content: "content_example", embed: false) // PostMessageRequest |  (optional)

// チャンネルにメッセージを投稿
ChannelAPI.postMessage_0(channelId: channelId, postMessageRequest: postMessageRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
postMessageRequest	PostMessageRequest		[optional]

Return type

Message

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setChannelSubscribers

    open class func setChannelSubscribers(channelId: UUID, putChannelSubscribersRequest: PutChannelSubscribersRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

チャンネルの通知購読者を設定

指定したチャンネルの通知購読者を設定します。リクエストに含めなかったユーザーの通知購読状態はオフになります。また、存在しないユーザーを指定した場合は無視されます。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let channelId = 987 // UUID | チャンネルUUID
let putChannelSubscribersRequest = PutChannelSubscribersRequest(on: [123]) // PutChannelSubscribersRequest |  (optional)

// チャンネルの通知購読者を設定
ChannelAPI.setChannelSubscribers(channelId: channelId, putChannelSubscribersRequest: putChannelSubscribersRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
channelId	UUID	チャンネルUUID
putChannelSubscribersRequest	PutChannelSubscribersRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ChannelAPI.md

Latest commit

History

ChannelAPI.md

File metadata and controls

ChannelAPI

createChannel

Example

Parameters

Return type

Authorization

HTTP request headers

editChannel

Example

Parameters

Return type

Authorization

HTTP request headers

editChannelSubscribers

Example

Parameters

Return type

Authorization

HTTP request headers

editChannelTopic

Example

Parameters

Return type

Authorization

HTTP request headers

getChannel

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelBots_0

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelEvents

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelPath

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelPins

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelStats

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelSubscribers

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelTopic

Example

Parameters

Return type

Authorization

HTTP request headers

getChannelViewers