Channel Developers

thumbnail
カテゴリー

App

スタートガイド(チュートリアル)

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 最初の Channel アプリを作る このページだけで、開発用 private app の作成から /tutorial Command、React WAM、bot/manager message の送信まで実行できます。Server language は TypeScript または Go のどちらかを選びます。 両方とも公式 SDK と公開 tutorial repository を使い、token 発行、Extension 登録、signature 検証、 WAM bridge を独自実装しません。 完了後は次を確認できます。 - SDK が command Extension と Function schema を自動登録する - /tutorial で Channel client 内に WAM が開く - WAM から app bot
スタートガイド(チュートリアル)

基本概念

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 基本概念 Channel アプリは、Function を実行するサーバーと、必要に応じて WAM として作る Web UI で構成されます。Extension は関連する Function を Channel の標準機能に接続し、AppStore は呼び出し・登録・権限の境界を担当します。 Channel client → AppStore → 署名付き PUT /functions/v1 → SDK の検証・dispatch → Function handler Function result → WAM を開く → WAM SDK → app Function または Channel native function Function Function は app server で実行される 1 つの型付き operation です。Call
基本概念

Function 登録

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 Function 登録 Function は Channel または他の app が app server に送る typed RPC です。Request の method が Function の完全な name で、params が input です。App 固有 Function は orders.get のような standalone name で登録し、標準 Extension Function は Extension name と relative name を組み合わせます。 Wire contract 受信 call は次の JSON-RPC-like envelope を使用します。 { "method": "orders.get", "params": { "orderId": "order-1" }, "context"
Function 登録

Command ガイド

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 Command ガイド Command Extension は user または manager が Channel の desk/front command UI から app 機能を 実行できるようにします。Command metadata が表示と input を定義し、metadata が参照する typed Function が実際の action を処理します。 現在の contract Function または field 必須 役割 extension.command.metadata.getCommands 必須 Command definition を discovery actionFunctionName Command ごと 選択された command を実行 autoCompleteFunctionName 任意 P
Command ガイド

WAM ガイド

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 WAM ガイド WAM(Web App Module)は Channel client 内で開く React web UI です。App server ではなく、server credential を保持しません。Command、widget、custom tab など、user interaction が必要な Extension action で使用します。 Action から WAM を開く Function が次の action result を返すと、Channel client が WAM を開きます。 { "type": "wam", "attributes": { "appId": "public-app-id", "name": "tutorial", "wamArgs": { "view": "summary" } } }
WAM ガイド

Extension 完全ガイド

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 Extension 完全ガイド Extension とは Extension は typed app Function を Channel の標準機能に接続する、名前と version を持つ契約です。 アプリが公式 Function name と schema を実装すると、Channel の画面は command、widget、custom tab、hook、OAuth などの機能を discovery して呼び出せます。 Extension は通常、2 種類の Function で構成されます。 Function の種類 役割 例 Metadata または discovery 機能を説明し、runtime Function を指す extension.command.metadata.getCommands Runtime または act
Extension 完全ガイド

本番運用準備ガイド

このドキュメントは Channel App SDK と一緒に管理されています。最新 package とドキュメント全体の順序は、まず SDK README を確認してください。この Document の基準となる原文は GitHub 原文です。 本番運用準備ガイド Install 済みの Test Channel でアプリの end-to-end flow が動作した後に、このガイドを使ってください。 最初の app Quickstart を完了するための必須ドキュメントではありません。動作する Function、 Extension、必要に応じた WAM を、安全に deploy・rollback・observe・operate できる release にする ことが目的です。 先に 基本概念、Extension 完全ガイド、必要な family recipe を完了して ください。正確な API は TypeScript reference と Go reference を基準に確認します。 このガイドの使い方 各 section を release gate として使います。アプ
本番運用準備ガイド