mobage.api
概要
此模块中的功能,包括从JavaScript调用Mobage Open Platform提供的Social API所需的功能。
功能列表
在mobage.api 模块中,有以下子模块和方法。原则上此模块的各方法中可使用的参数等依据后端的RESTful API。
- mobage.api.people
- mobage.api.appdata
- mobage.api.avatar
- mobage.api.textdata
- mobage.api.textdataGroup
- mobage.api.profanity
- mobage.api.blacklist
- mobage.api.bankInventory
- mobage.api.chatChannel
- mobage.api.chatMember
- mobage.api.chatMessage
- mobage.api.chatUserChannel
通用事项
Common Query Parameters
mobage.api 模块中的API与RESTful API同样,可使用GET类的方法和部分PUT方法,对筛选和排序所需的查询参数进行指定。
以下面指定查询参数。关于它们的使用,请参见前项所述对应RESTful API的。
| property | title | type | required | description |
|---|---|---|---|---|
| fields | 想要获取的字段列表 | array | false | 使用逗号分隔列表,指定想要获取的字段。 |
| count | 想要获取的条数 | integer | false | 指定想要获取的条数。如果省略,通常视为指定 50。 |
| startIndex | 开始位置 | integer | false | 指定开始位置。默认值和最小值为 1。 |
| filterBy | 过滤条件字段 | integer | false | 指定想要指定条件的字段名。 |
| filterOp | 过滤条件式 | string | false | 指定equals 等条件式。 |
| filterValue | 过滤值 | string | false | 指定过滤条件值。 |
| sortBy | 排序字段 | string | false | 指定排序条件的字段名。 |
| sortOrder | 排序顺序 | string | false | 指定排序的顺序 (ascending, descending)。 |
Error Response
Social API执行错误时,向前项所述Callback函数的error参数传递mobage.error.APIError对象。此 mobage.error.APIError对象带有的属性如下所示。
| property | title | type | description |
|---|---|---|---|
| httpStatus | HTTP 响应状态代码 | integer | 实际反馈的 HTTP 状态代码值。 |
| title | 错误标题 | string | Human Readable 错误的标题。 |
| detail | 错误详细 | string | (Optional) 错误的补充信息。 |
方法
mobage.api.people.get
获取People 所需的 API 。是People API - RESTful API的JavaScript接口。
语法
mobage.api.people.get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 指定核心用户的ID。如果指定 @me,则视为指定access token的Re-sourceOwner的用户ID。 |
| groupId | 群组 ID | string | true | 指定 @self 时,参照自身的资源。指定 @friends, @all时,参照{userId}中指定的用户好友列表的资源。 |
| personId | 对方的用户ID | string | false | 当{groupId}被指定为@friends, @all 时,如果指定的{personId}非好友,会反馈404 Not Found。 |
cb
function型的参数。
说明
详情请见People API - RESTful API。
mobage.api.appdata.get
设置、获取Appdata所需的API 。是AppData API - RESTful API的JavaScript接口。
语法
mobage.api.appdata.get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 指定核心用户的ID。如果指定 @me,则视为指定access token的Re-sourceOwner的用户ID。 |
| groupId | 群组 ID | array | true | 指定 @self 时,参照自身的资源。指定 @friends, @all时,参照userId中指定的用户好友列表的资源。 |
| appId | 应用软件 ID | array | true | 请指定@app或当前执行的应用软件的 ID。 |
cb
function型的参数。
mobage.api.appdata.update
创建和更新Appdata时,请使用此处的方法。
语法
mobage.api.appdata.update(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 指定核心用户的ID。如果指定 @me,则视为指定access token的Re-sourceOwner的用户ID。 |
| groupId | 群组 ID | array | true | 指定 @self 时,参照自身的资源。指定 @friends, @all时,参照userId中指定的用户好友列表的资源。 |
| appId | 应用软件 ID | array | true | 请指定@app或当前执行的应用软件的 ID。 |
cb
function 型的参数。
mobage.api.appdata.delete
语法
mobage.api.appdata.delete(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 指定核心用户的ID。如果指定 @me,则视为指定access token的Re-sourceOwner的用户ID。 |
| groupId | 群组 ID | array | true | 指定 @self 时,参照自身的资源。指定 @friends, @all时,参照userId中指定的用户好友列表的资源。 |
| appId | 应用软件 ID | array | true | 请指定@app或当前执行的应用软件的 ID。 |
cb
function型的参数。
mobage.api.avatar.get
获取Avatar所需的 API 。是Avatar API - RESTful API的JavaScript接口。
语法
mobage.api.avatar.get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string or array | true | 指定核心用户的ID。如果指定 @me,则视为指定access token的Re-sourceOwner的用户ID。 |
| groupId | 群组 ID | string | true | 指定 @self 时,参照自身的资源。指定 @friends, @all时,参照userId中指定的用户好友列表的资源。 |
| size | 大小 | string | false | 指定large/medium/small 中的任意一项。 |
| view | 显示 | string | false | 指定entire/upper 中的任意一项。 |
| emotion | 表情 | string | false | 指定defined/normal/smile/cry/angry/shy中的任意一项。 |
| dimension | 选择2D/3D | string | false | 指定defined/2D/3D 中的任意一项。 |
| transaparent | 透明 | string | false | 指定true/false 中的任意一项。 |
| type | 格式类型 | string | false | 指定image 中的任意一项 |
| extension | 格式扩展名 | string | false | 指定gif/png 中的任意一项 |
cb
function型的参数。
说明
详情请参见 Avatar API - RESTful API。
mobage.api.textdata.get
获取TextData所需的API 。是TextData API - RESTful API的JavaScript接口。
语法
mobage.api.textdata.get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 请指定@app或当前执行的应用软件的 ID。 |
| textdataGroupName | TextDataGroup 的 name | string | true | 指定TextDataGroup 的 name 字段值。 |
| groupId | 群组 ID | string | true | 指定@all。 |
| textdataId | TextData 的 id | string or array | false | 指定TextData 的 id。 |
cb
function型的参数。
说明
详情请参见Textdata API - RESTful API。
mobage.api.textdataGroup.get
获取TextDataGroup所需的 API。是TextData API - RESTful API的JavaScript接口。
语法
mobage.api. textdataGroup .get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 请指定@app或当前执行的应用软件的 ID。 |
| groupId | 群组 ID | string | true | 指定 @all。 |
cb
function 型的参数。
说明
详情请参见Textdata API - RESTful API。
mobage.api.profanity.check
检查用户输入字符串中有无不当语句所需的 API。是Profanity API - RESTful API的JavaScript接口。
语法
mobage.api. profanity .check(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| text | 自由文本 | string | true | 请指定用户发帖的自由文本。 |
cb
function 型的参数。
说明
详情请参见 profanity API - RESTful API。
mobage.api.blacklist.get
获取BlackList所需的 API 。是BlackList API - RESTful API的JavaScript接口。
语法
mobage.api. blacklist .get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 表示当前登录用户的 @me或用户ID。 |
| groupId | 群组 ID | string | true | 指定 @all。 |
| personId | 用户 ID | string | true | 想要确认是否已被拉黑的用户 ID。 |
cb
function型的参数。
说明
详情请参见Blacklist API - RESTful API。
mobage.api.bankInventory.get
获取Bank Inventory所需的API 。是处理Bank API - RESTful API 中的 Inventory 的JavaScript接口。
语法
mobage.api. bankInventory .get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 指定 @app 或应用软件ID。 |
| itemId | 物品 ID | string | false | 指定在Mobage Developers Japan(开发者网站)中注册的特定物品ID。 |
cb
function 型的参数。
说明
详情请参见Blacklist API - RESTful API。
mobage.api.chatChannel.get
获取Chat Channel所需的API 。是Chat Channel API - RESTful API的JavaScript接口。
语法
mobage.api. chatChannel .get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 指定 @app 或应用软件的ID。 |
| channelId | 频道 ID | string | false | 指定频道的 ID。 |
cb
function 型的参数。
说明
详情请参见 ChatChannel API - RESTful API 。
mobage.api.chatMember.get
获取Chat Member 所需的 API 。是Chat Member API - RESTful API的JavaScript 接口。
语法
mobage.api. chatMember .get(params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 指定 @app 或应用软件的ID。 |
| channelId | 频道 ID | string | true | 指定频道的 ID。 |
| id | Chat Member 的 id | string | false | 指定Chat Member 对象的 ID。 |
cb
function型的参数。
说明
详情请参见ChatMember API - RESTful API。
mobage.api.chatMessage.get
获取Chat Message 所需的 API 。是Chat Message API - RESTful API 的 JavaScript 接口。
语法
mobage.api. chatMessage .get(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | 应用软件 ID | string | true | 指定 @app 或应用软件的ID。 |
| channelId | 频道 ID | string | true | 指定频道的 ID。 |
| id | Chat Member 的 id | string | false | 指定Chat Member 对象的 ID。 |
cb
function型的参数。
说明
详情请参见ChatMessage API - RESTful API。
mobage.api.userChatChannel.get
获取User Chat Channel所需的 API 。是User Chat Channel API - RESTful API的JavaScript 接口。
语法
mobage.api. userChatChannel .get(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | 用户 ID | string | true | 指定 @me 或用户的 ID。 |
| groupId | 群组 ID | string | true | 指定 @self 。 |
| channelId | 频道 ID | string | false | 指定频道的 ID。 |
cb
function型的参数。
说明
详情请参见UserChatChannel API - RESTful API。