固定メッセージ

固定メッセージ

チャットで固定メッセージ(Pinned Message)とは、チャットルームやグループ会話で重要なメッセージをチャンネルや会話ウィンドウの上部に固定する機能を指します。この機能は、参加者がそのチャットを開くたびに簡単に見ることができ、重要な情報や通知を見逃さないようにするのに役立ちます。以下は、固定メッセージの主な特徴と活用方法についての説明です。

固定メッセージの活用方法

• 会議日程のお知らせ : 定期的な会議や重要なイベントの日程を固定メッセージに設定し、参加者が日程を忘れないようにします。
• 重要文書のリンク : 重要な文書や資料のリンクを固定して、すべての参加者が簡単にアクセスできるようにします。
• ルールとガイドラインの共有 : チャットルームのルールやプロジェクトのガイドラインを固定メッセージとして設定し、新しい参加者も簡単にガイドラインを確認できるようにします。
• 緊急速報 : 緊急に伝えるべき内容や変更点を固定メッセージで素早く共有できます。

固定メッセージ機能は様々なコミュニケーションプラットフォームで提供されており、これを効果的に活用することでチームコミュニケーションの効率を大幅に向上させることができます。

固定メッセージ作成

チャットアプリケーションで重要なメッセージをユーザーが簡単に見られるように上部に固定する機能です。以下の C#コードは、チャットチャンネルでメッセージを固定する方法を示しています。

Javascript/Typescript

const pin = {
  pinned: true,
  messageId: messageId
  pinnedAt: new Date().toString(),
  expiredAt: "",
};
const data = await nc.createPin(channelId, pin);

Android (Kotlin)

NChat.createPin(channelId, messageId, true, "","") { pin, e->
    if (e != null) {
        // エラー
    } else {
        // 成功
    }
}

iOS (Swift)

NChat.createPin(channelId: channelId, messageId: messageId, pinned: pinned, pinnedAt: pinnedAt, expiredAt: ExpiredAt) { result in 
    switch(result)
    {
    case .success(let pin) :
        break;
    case .failure(let error) :
        break
    }
}

Unity

var newPin = await nc.createPin(channelId, messageId, pinned, pinnedAt, expiredAt);

• channelId: メッセージが固定されるチャットチャンネルの固有 IDです。
• pinned: 固定するメッセージの内容です。
• pinnedAt: メッセージが固定された時刻を示します。
• expiredAt: メッセージの固定が解除される時刻です。

この関数を使用すると、特定のチャットチャンネル内で重要なメッセージを簡単にハイライトして表示できます。

固定メッセージ変更

既存の固定メッセージの情報を更新するための機能です。メッセージの内容、固定時刻、または有効期限を変更できます。

Javascript/Typescript

const pin = {
    pinned: true,
    pinnedAt: new Date().toString(),
    expiredAt: "",
};
const data = await nc.updatePin(pinId, channelId, pin);

Android (Kotlin)

NChat.updatePin(channelId, pinId, true) { pin, e ->
    if (e != null) {
        // エラー
        addMessage("createPin Error: ${e.message}", true)
    } else {
        // 成功
        addMessage("createPin ${pin}", true)
    }
}

iOS (Swift)

NChat.updatePin(pinId: pinId, channelId: channelId, pinned: pinned, pinnedAt: pinnedAt, expiredAt: ExpiredAt) { result in 
    switch(result)
    {
    case .success(let pin) :
        break;
    case .failure(let error) :
        break
    }
}

Unity

var updatedPin = await nc.updatePin(id, channelId, pinned, pinnedAt, expiredAt);

• channelId: 変更するメッセージがあるチャンネルの IDです。
• pinned: 変更されたメッセージの内容です。
• pinnedAt: メッセージが新しく固定された時刻です。
• expiredAt: メッセージ固定の新しい有効期限です。

このコードは、既に固定されたメッセージの詳細を変更するときに使用され、メッセージの重要性が変更されたり固定時間を調整する必要がある場合に便利です。

固定メッセージ情報

特定メッセージの固定関連情報を照会する機能です。これにより、メッセージの固定ステータス、固定時刻、有効期限などを確認できます。

Javascript/Typescript

const pin = await nc.getPin(channelId, pinId);

Android (Kotlin)

NChat.getPin(channelId, pinId) { pin, e ->
    if (e != null) {
        // エラー
    } else {
        // 成功
    }
}

iOS (Swift)

NChat.getPin(channelId: channelId, pinId: pinId) { result in 
    switch(result)
    {
    case .success(let pins) :
        break;
    case .failure(let error) :
        break
    }
}

Unity

var pin = await nc.getPin(channelId, messageId);

• channelId: 情報を照会するチャンネルの IDです。
• messageId: 固定されたメッセージの固有 IDです。

この関数を通じて特定のメッセージが現在どのようなステータスであるかを確認でき、管理者やユーザーがチャンネル内のメッセージをより効果的に管理するのに役立ちます。

固定メッセージリスト

チャットチャンネルで現在固定されているすべてのメッセージのリストを照会する機能です。この関数はページングをサポートし、大規模なチャンネルでも効率的にデータを処理できます。offsetと per_pageを設定することで、ユーザーは希望する範囲のデータを取得できます。

Javascript/Typescript

const filter = { channel_id: channelId };
const sort = { created_at: -1 };
const option = { offset: 0, per_page: 100 };
const pins = await nc.getPins(channelId, filter, sort, option);

Android (Kotlin)

val filter: Map<String, Any?> = mapOf("" to "")
val sort: Map<String, Any?> = mapOf(
    "created_at" to -1
)
val options: Map<String, Any?> = mapOf(
    "per_page" to 10,
    "offset" to 0
)
NChat.getPins(channelId, filter, sort, options) { pins, e ->
    if (e != null) {
        // エラー
    } else {
        // 成功
    }
}

iOS (Swift)

let filter: [String: Any] = ["":""]
let option: [String: Any] = ["per_page": 10, "offset": 0]
let sort: [String: Any] = ["created_at": "-1"]
NChat.getPins(channelId: channelId, filter: filter, option: option, sort: sort) { result in
    switch(result)
    {
    case .success(let pins) :
        break;
    case .failure(let error) :
        break
    }
}

Unity

Hashtable filter = new Hashtable
{
    { "channel_id", channelId },
};
Hashtable sort = new Hashtable
{
    { "created_at", -1 },
};
Hashtable option = new Hashtable
{
    { "offset", 0 },
    { "per_page", 10 },
};
var pins = await nc.getPins(channelId, filter, sort, option);

パラメータの説明

• filter : 照会するデータをフィルタリングするための条件を定義します。例えば、特定のチャンネルで固定メッセージを照会できます。
• sort : 結果リストのソート方法を定義します。ここでは、作成時間(created_at)を基準に降順(-1)ソートを使用します。
• option : 照会時に使用するオプションを定義します。offsetは照会開始位置、per_pageはページごとに表示されるメッセージの数を指定します。

オプションの詳細

この機能を使用すると、チャンネル管理者はチャンネル内で重要なメッセージを簡単にモニタリングして管理できます。また、特定のユーザーや時間基準で固定メッセージを素早く検索・ソートでき、チャンネルの効率的な運用に役立ちます。