Skip to content

FavoriteAPI

kishino edited this page Feb 28, 2022 · 3 revisions

お気に入り管理API

お気に入り管理APIは以下のメソッドを提供します。

addObjectDataToFavoriteメソッド

指定したオブジェクトデータをお気に入りとして登録します。

RKZClient.addObjectDataToFavorite(objectData, userAccessToken, success, error);
  • objectData: Object オブジェクトデータ情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    オブジェクトのお気に入り情報を取得するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数

⚠️ v2.0.0 より、addFavoriteToObjectDataメソッドは非推奨になりました。かわりに、addObjectDataToFavoriteメソッドを使用してください。

deleteObjectDataFromFavoriteメソッド

登録されているオブジェクトデータのお気に入り情報を削除します。

RKZClient.deleteObjectDataFromFavorite(objectData, userAccessToken, success, error);
  • objectData: Object オブジェクトデータ情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    オブジェクトのお気に入り情報を削除するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数

⚠️ v2.0.0 より、deleteFavoriteToObjectDataメソッドは非推奨になりました。かわりに、deleteObjectDataFromFavoriteメソッドを使用してください。

addNewsToFavoriteメソッド

指定したお知らせをお気に入りとして登録します。

RKZClient.addNewsToFavorite(news, userAccessToken, success, error);
  • news: Object お知らせ情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    お知らせのお気に入り情報を取得するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数

deleteNewsFromFavoriteメソッド

登録されているお知らせのお気に入り情報を削除します。

RKZClient.deleteNewsFromFavorite(news, userAccessToken, success, error);
  • news: Object お知らせ情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    お知らせのお気に入り情報を削除するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数

addUserDetailToFavoriteメソッド

指定したユーザー詳細をお気に入りとして登録します。

RKZClient.addUserDetailToFavorite(userDetail, userAccessToken, success, error);
  • userDetail: Object ユーザー詳細情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    ユーザー詳細のお気に入り情報を取得するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数

deleteUserDetailFromFavoriteメソッド

登録されているユーザー詳細のお気に入り情報を削除します。

RKZClient.deleteNewsFromFavorite(userDetail, userAccessToken, success, error);
  • userDetail: Object ユーザー詳細情報オブジェクト(必須)

  • userAccessToken: String ユーザーアクセストークン (必須)

    ユーザー詳細のお気に入り情報を削除するユーザーのアクセストークンを指定します。

  • success: function 成功時コールバック関数

    function(statusCode) {
        // 成功時の処理
    }
    • statusCode: String 正常終了のステータスコード
  • error: function 失敗時のコールバック関数