メソッドの概要

返却値の型 メソッド名
ResultObject countAllReadUsers (MessageKey messageKey)
既読済みユーザ数の取得を行います。
ResultObject countAllUnreadMessages (String userCd, Number limit)
全タイムラインの未読メッセージ件数の取得を行います。
ResultObject countAllUnreadMessages (Number limit)
全タイムラインの未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesByThread (String userCd, Number limit, Array threadIds)
スレッド内の未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesByThread (Number limit, Array threadIds)
スレッド内の未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesByTimeline (String userCd, Number limit, Array timelineIds)
タイムラインの未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesByTimeline (Number limit, Array timelineIds)
タイムラインの未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesInThread (String userCd, Number limit, String threadId, String start)
スレッド内の未読メッセージ件数の取得を行います。
ResultObject countUnreadMessagesInThread (Number limit, String threadId, String start)
スレッド内の未読メッセージ件数の取得を行います。
ResultObject getAllReadUsers (Array messageKeys)
既読済みのユーザ一覧の取得を行います。
ResultObject getAllUnreadMessages (String userCd, Number limit)
全タイムラインの未読メッセージIDの取得を行います。
ResultObject getAllUnreadMessages (Number limit)
全タイムラインの未読メッセージIDの取得を行います。
ResultObject getReadUsers (MessageKey messageKey, String start)
既読済みのユーザの取得を行います。
ResultObject getUnreadMessagesByThread (String userCd, Number limit, Array threadIds)
スレッド内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessagesByThread (Number limit, Array threadIds)
スレッド内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessagesByTimeline (Number limit, String userCd, Array timelineIds)
タイムライン内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessagesByTimeline (Number limit, Array timelineIds)
タイムライン内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessagesInThread (String userCd, Number limit, String threadId, String start)
スレッド内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessagesInThread (Number limit, String threadId, String start)
スレッド内の未読メッセージIDの取得を行います。
ResultObject getUnreadMessages (Array messageIds)
指定したメッセージIDが未読の場合、未読メッセージID返却をします。
ResultObject getUnreadMessages (String userCd, Array messageIds)
指定したメッセージIDが、未読メッセージID返却をします。
ResultObject readAll ()
すべてのメッセージの未読解除を行います。
ResultObject readAll (String userCd)
すべてのメッセージの未読解除を行います。
ResultObject readThread (Array threadIds)
指定したスレッドのメッセージの未読解除を行います。
ResultObject readThread (String userCd, Array threadIds)
指定したスレッドのメッセージの未読解除を行います。
ResultObject readTimeline (Array timelineIds)
指定したタイムラインのすべてのメッセージの未読解除を行います。
ResultObject readTimeline (String userCd, Array timelineIds)
指定したタイムラインのすべてのメッセージの未読解除を行います。
ResultObject read (Array messageIds)
指定したメッセージの未読解除を行います。
ResultObject read (String userCd, Array messageIds)
指定したメッセージの未読解除を行います。

メソッドの詳細

ResultObject countAllReadUsers (MessageKey messageKey)
既読済みユーザ数の取得を行います。
パラメータ
messageKey : MessageKey
メッセージキー
返却値
ResultObject
ResultObject 処理結果
data プロパティには、既読済みユーザ数が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countAllUnreadMessages (String userCd, Number limit)
全タイムラインの未読メッセージ件数の取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countAllUnreadMessages (Number limit)
全タイムラインの未読メッセージ件数の取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesByThread (String userCd, Number limit, Array threadIds)
スレッド内の未読メッセージ件数の取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesByThread (Number limit, Array threadIds)
スレッド内の未読メッセージ件数の取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesByTimeline (String userCd, Number limit, Array timelineIds)
タイムラインの未読メッセージ件数の取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesByTimeline (Number limit, Array timelineIds)
タイムラインの未読メッセージ件数の取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesInThread (String userCd, Number limit, String threadId, String start)
スレッド内の未読メッセージ件数の取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
引数メッセージIDstart)を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージIDstart)にnullを指定した場合は先頭からのメッセージが返却されます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadId : String
スレッドID
start : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject countUnreadMessagesInThread (Number limit, String threadId, String start)
スレッド内の未読メッセージ件数の取得を行います。
引数メッセージIDstart)を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージIDstart)にnullを指定した場合は先頭からのメッセージが返却されます。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadId : String
スレッドID
start : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getAllReadUsers (Array messageKeys)
既読済みのユーザ一覧の取得を行います。
パラメータ
messageKeys : Array
メッセージキー一覧
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、既読済みのユーザの一覧の格納された連想配列が設定されます。
data プロパティに格納される連想配列は、スレッドID、メッセージIDをキーとした二次元構造となっています。
ResultObject getAllUnreadMessages (String userCd, Number limit)
全タイムラインの未読メッセージIDの取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getAllUnreadMessages (Number limit)
全タイムラインの未読メッセージIDの取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージ件数の一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getReadUsers (MessageKey messageKey, String start)
既読済みのユーザの取得を行います。
引数ユーザコード(start)を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード(start)にnullを指定した場合は先頭からのユーザ情報が返却されます。
パラメータ
messageKey : MessageKey
メッセージキー
start : String
ユーザコード
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、既読済みのユーザの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesByThread (String userCd, Number limit, Array threadIds)
スレッド内の未読メッセージIDの取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesByThread (Number limit, Array threadIds)
スレッド内の未読メッセージIDの取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesByTimeline (Number limit, String userCd, Array timelineIds)
タイムライン内の未読メッセージIDの取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
userCd : String
ユーザコード
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesByTimeline (Number limit, Array timelineIds)
タイムライン内の未読メッセージIDの取得を行います。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、タイムラインIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesInThread (String userCd, Number limit, String threadId, String start)
スレッド内の未読メッセージIDの取得を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
引数メッセージIDstart)を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージIDstart)にnullを指定した場合は先頭からのメッセージが返却されます。
パラメータ
userCd : String
ユーザコード
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadId : String
スレッドID
start : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessagesInThread (Number limit, String threadId, String start)
スレッド内の未読メッセージIDの取得を行います。
引数メッセージIDstart)を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージIDstart)にnullを指定した場合は先頭からのメッセージが返却されます。
パラメータ
limit : Number
取得最大件数(0を指定した場合、全件取得を行います。)
threadId : String
スレッドID
start : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドIDをキーとした、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessages (Array messageIds)
指定したメッセージIDが未読の場合、未読メッセージID返却をします。
パラメータ
messageIds : Array
メッセージID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getUnreadMessages (String userCd, Array messageIds)
指定したメッセージIDが、未読メッセージID返却をします。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
messageIds : Array
メッセージID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、未読メッセージIDの一覧が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject readAll ()
すべてのメッセージの未読解除を行います。
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject readAll (String userCd)
すべてのメッセージの未読解除を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject readThread (Array threadIds)
指定したスレッドのメッセージの未読解除を行います。
パラメータ
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject readThread (String userCd, Array threadIds)
指定したスレッドのメッセージの未読解除を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
threadIds : Array
スレッドID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject readTimeline (Array timelineIds)
指定したタイムラインのすべてのメッセージの未読解除を行います。
パラメータ
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject readTimeline (String userCd, Array timelineIds)
指定したタイムラインのすべてのメッセージの未読解除を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
timelineIds : Array
タイムラインID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject read (Array messageIds)
指定したメッセージの未読解除を行います。
パラメータ
messageIds : Array
メッセージID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject read (String userCd, Array messageIds)
指定したメッセージの未読解除を行います。
ユーザコードの指定がない場合は、コンテキストのユーザコードで処理が行われます。
パラメータ
userCd : String
ユーザコード
messageIds : Array
メッセージID(複数指定可)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。