Mobile Platform as a Service:ネットワーク

my.request

ミニアプリからネットワークリクエストを実行します。

• my.request API は現在、GET、POST、および DELETE メソッドをサポートしています。

• my.request API は現在、HTTPS リクエストのみをサポートしています。

詳細については、「my.request よくある質問」をご参照ください。

注意事項：

• ミニアプリのリリース ＞ オープンプラットフォームミニアプリ管理 で 権限制御スイッチ を有効にしてください。その後、サーバードメイン名ホワイトリスト でドメイン名ホワイトリストを構成します。ミニアプリは、HTTP リクエスト (my.request) やファイルアップロード (my.uploadFile) などの API を呼び出す際、ホワイトリストに登録されたドメイン名とのみ通信できます。

• サーバードメイン名ホワイトリストにドメイン名を追加した後は、変更を有効にするために再パッケージ化、アップロード、試用版の生成を行う必要があります。

• IDE でデバッグする場合は、プレビューに実機を使用してください。

入力パラメーター

data パラメーターの説明

サーバーに送信されるデータは最終的に文字列に変換されます。データが文字列でない場合、以下のルールに基づいて変換されます。

• メソッドが GET の場合、データはクエリ文字列に変換されます：encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...。

• メソッドが POST で、headers['content-type'] が application/json の場合、データは JSON にシリアル化されます。

• メソッドが POST で、headers['content-type'] が application/x-www-form-urlencoded の場合、データはクエリ文字列に変換されます：encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...。

referer の説明

• ネットワークリクエストの referer ヘッダーを設定することはできません。

• その形式は https://urlhost/{appid}/{version}/page-frame.html に固定されています。ここで、{appid} はミニアプリの APPID、{version} はミニアプリのバージョン番号です。

success 戻り値

エラーコード

my.request 呼び出しが このインターフェイスを呼び出す権限がありません というエラーを返す場合は、オープンプラットフォームミニアプリ管理 ＞ サーバードメイン名ホワイトリスト でドメイン名ホワイトリストを構成してください。

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.request({
  url: 'https://example.org/post',
  method: 'POST',
  data: {
    from: 'Alipay',
    production: 'AlipayJSAPI',
  },
  dataType: 'json',
  success: function(res) {
    my.alert({content: 'success'});
  },
  fail: function(res) {
    my.alert({content: 'fail'});
  },
  complete: function(res) {
    my.hideLoading();
    my.alert({content: 'complete'});
  }
});

// RequestTask を返します。これにより abort メソッドを呼び出してリクエストをキャンセルできます。
const task = my.request({url: 'https://example.org/post'})
task.abort()

戻り値

RequestTask

ネットワークリクエストタスクオブジェクト。

メソッド

RequestTask.abort()

my.uploadFile

ローカルリソースを開発者のサーバーにアップロードします。

注意事項：

• オープンプラットフォームミニアプリ管理 ＞ サーバードメイン名ホワイトリスト でドメイン名ホワイトリストを構成してください。ミニアプリは、HTTP リクエスト (my.request) やファイルアップロード (my.uploadFile) などの API を呼び出す際、ホワイトリストに登録されたドメイン名とのみ通信できます。

入力パラメーター

success 戻り値

エラーコード

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.uploadFile({
  url: 'ご自身のサーバーアドレスを使用してください',
  fileType: 'image',
  fileName: 'file',
  filePath: '...',
  success: (res) => {
    my.alert({
      content: 'Upload successful'
    });
  },
});

UploadTask

アップロード進捗の変化を監視し、アップロードタスクをキャンセルするためのオブジェクト。

メソッド

コード例

const task = my.uploadFile({
  url: 'ご自身のサーバーアドレスを使用してください',
  fileType: 'image',
  fileName: 'file',
  filePath: '...',
});
task.onProgressUpdate(({progress, totalBytesWritten, totalBytesExpectedToWrite}) => {
})
task.abort()

よくある質問

• Q：ミニアプリは、アップロードされた画像を Base64（バイナリデータを印刷可能な文字で表現する方法）に自動変換できますか？

  A：いいえ、ミニアプリは画像を Base64 に変換することをサポートしていません。

• Q：my.uploadFile を使用して、サーバーから返されたエラーメッセージを取得するにはどうすればよいですか？

  A：

  • `success` コールバックの `data` パラメーターから取得します。

  • サーバー側にログ検索 API を追加します。アップロードが失敗した場合、ログ検索 API を呼び出して詳細な失敗ログを取得します。

• Q：my.uploadFile のデフォルトタイムアウトはどのくらいですか？デフォルトタイムアウトを延長できますか？

  A：my.uploadFile のデフォルトタイムアウトは 30 秒です。いいえ、デフォルトタイムアウトを延長することはできません。

• Q：ファイルをアップロードする際に my.uploadFile が error: 12 を報告するのはなぜですか？

  A：エラーコード 12 はアップロード失敗を示します。失敗の原因として考えられるのは以下のとおりです。

  • ファイルが大きすぎます。

  • アップロードに 30 秒以上かかりました。

  • 権限がありません。

• Q：バックエンドは my.uploadFile を使用する際にバイナリイメージを受け取ります。バックエンドがこのバイナリイメージをミニアプリに返す場合、ミニアプリはそれをどのように解析しますか？

  A：バックエンドはイメージをバイナリストリームとして受け取ります。バックエンドは、サーバー上のイメージの場所の URL を提供するだけで十分です。

• Q：my.uploadFile を呼び出すと error: 4（この API を呼び出す権限がありません）と報告されるのはなぜですか？

  A：リクエストされた URL がホワイトリストに含まれていません。URL のドメイン名をホワイトリストに追加してください。

• Q：ミニアプリは Excel ファイルのアップロードをサポートしていますか？

  A：いいえ。現在、my.uploadFile は image、video、audio タイプのファイルのアップロードのみをサポートしています。他のファイルタイプはサポートされていません。

• Q：my.uploadFile は複数の画像を同時にアップロードできますか？

  A：いいえ、my.uploadFile は複数の画像を同時にアップロードすることをサポートしていません。一度にアップロードできるのは 1 枚の画像のみです。

my.downloadFile

ファイルリソースをローカルデバイスにダウンロードします。

入力パラメーター

success 戻り値

エラーコード

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

// API-DEMO page/API/download-file/download-file.json
{
    "defaultTitle": "Download File"
}

<!-- API-DEMO page/API/download-file/download-file.axml-->
<view class="container">
  <button onTap="download">Download and display image</button>
</view>

// API-DEMO page/API/download-file/download-file.js
Page({
  download() {
    my.downloadFile({
      url: 'https://img.alicdn.com/tfs/TB1x669SXXXXXbdaFXXXXXXXXXX-520-280.jpg',
      success({ apFilePath }) {
        my.previewImage({
          urls: [apFilePath],
        });
      },
      fail(res) {
        my.alert({
          content: res.errorMessage || res.error,
        });
      },
    });
  },
})

my.connectSocket

WebSocket 接続を作成します。

ミニアプリは一度に 1 つの WebSocket 接続しか持つことができません。すでに WebSocket 接続が存在する場合、自動的に閉じられ、新しい接続が作成されます。

入力パラメーター

エラーコード

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.connectSocket({
  url: 'test.php',
  data: {},
  header:{
    'content-type': 'application/json'
  },
});

my.onSocketOpen

WebSocket 接続オープンイベントを監視します。

入力パラメーター

以下のプロパティを持つオブジェクト型：

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.connectSocket({
  url: 'test.php',
});

my.onSocketOpen(function(res) {
  console.log('WebSocket connection is open!');
});

my.offSocketOpen

WebSocket 接続オープンイベントの監視を停止します。

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

Page({
  onLoad() {
    this.callback = this.callback.bind(this);
    my.onSocketOpen(this.callback);
  },
  onUnload() {
    my.offSocketOpen(this.callback);
  },
  callback(res) {
  },
})

コールバック値を渡すかどうか

• コールバック値を渡さない場合、このリスナーのすべてのイベントコールバックが削除されます。以下のコードが例です。

  my.offSocketOpen();

• コールバック値を渡す場合、対応するコールバックイベントのみが削除されます。以下のコードが例です。

  my.offSocketOpen(this.callback);

my.onSocketError

WebSocket エラーを監視します。

入力パラメーター

以下のプロパティを持つオブジェクト型：

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.connectSocket({
  url: 'Your server address'
});

my.onSocketOpen(function(res){
  console.log('WebSocket connection is open!');
});

my.onSocketError(function(res){
  console.log('WebSocket connection failed. Please check!');
});

my.offSocketError

WebSocket エラーの監視を停止します。

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

Page({
  onLoad() {
    this.callback = this.callback.bind(this);
    my.onSocketError(this.callback);
  },
  onUnload() {
    my.offSocketError(this.callback);
  },
  callback(res) {
  },
})

コールバック値を渡すかどうか

• コールバック値を渡さない場合、このリスナーのすべてのイベントコールバックが削除されます。以下のコードが例です。

  my.offSocketError();

• コールバック値を渡す場合、対応するコールバックイベントのみが削除されます。以下のコードが例です。

  my.offSocketError(this.callback);

my.sendSocketMessage

WebSocket 接続経由でデータを送信します。まず my.connectSocket を使用して接続を開始し、その後 my.onSocketOpen コールバック後にデータを送信する必要があります。

入力パラメーター

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.sendSocketMessage({
    data: this.data.toSendMessage, // The content to send
    success: (res) => {
        my.alert({content: 'Data sent! ' + this.data.toSendMessage});
    },
});

my.onSocketMessage

WebSocket 接続経由でサーバーから受信したメッセージを監視します。

コールバック戻り値

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.connectSocket({
  url: 'Server address'
})

my.onSocketMessage(function(res) {
  console.log('Received server content: ' + res.data)
})

my.offSocketMessage

WebSocket 接続経由でサーバーから受信したメッセージの監視を停止します。

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.connectSocket({
  url: 'Server address'
})
my.onSocketMessage(function(res) {
  console.log('Received server content: ' + res.data)
})
my.offSocketMessage();

コールバック値を渡すかどうか

• コールバック値を渡さない場合、このリスナーのすべてのイベントコールバックが削除されます。以下のコードが例です。

  my.offSocketMessage();

• コールバック値を渡す場合、対応するコールバックイベントのみが削除されます。以下のコードが例です。

  my.offSocketMessage(this.callback);

my.closeSocket

WebSocket 接続を閉じます。

入力パラメーター

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

my.onSocketOpen(function() {
  my.closeSocket()
})

my.onSocketClose(function(res) {
  console.log('WebSocket connection is closed!')
})

my.onSocketClose

WebSocket 閉鎖イベントを監視します。

入力パラメーター

以下のプロパティを持つオブジェクト型：

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

onLoad() {
    // Note: Register the callback method only once during the miniapp startup phase.
    // If you call it multiple times, the callback will be triggered multiple times.
    my.onSocketClose((res) => {
      my.alert({content: 'Connection closed!'});
      this.setData({
        sendMessageAbility: false,
        closeLinkAbility: false,
      });
    });
    // Note: Register the callback method only once during the miniapp startup phase.
    // If you call it multiple times, the callback will be triggered multiple times.
    my.onSocketOpen((res) => {
      my.alert({content: 'Connection opened!'});
      this.setData({
        sendMessageAbility: true,
        closeLinkAbility: true,
      });
    });

    my.onSocketError(function(res){
      my.alert('WebSocket connection failed. Please check! ' + res);
    });

    // Note: Register the callback method only once during the miniapp startup phase.
    // If you call it multiple times, the callback will be triggered multiple times.
    my.onSocketMessage((res) => {
      my.alert({content: 'Data received! ' + JSON.stringify(res)});
    });
  }

connect_start() {
    my.connectSocket({
      url: 'Server address', // The developer's server API address. It must use the wss protocol, and the domain name must be a legitimate domain name configured in the backend.
      success: (res) => {
        my.showToast({
          content: 'success', // Text content
        });
      },
      fail:()=>{
        my.showToast({
          content: 'fail', // Text content
        });
      }
    });
  },

my.offSocketClose

WebSocket 閉鎖イベントの監視を停止します。

コード例

この例は参考用です。テストにはご自身のアドレスを使用してください。

Page({
  onLoad() {
  my.onSocketClose(this.callback);
  },
  onUnload() {
    my.offSocketClose(this.callback);
    //    my.offSocketClose();
  },
  callback(res) {
  my.alert({content: 'Connection closed!'});
      this.setData({
        sendMessageAbility: false,
        closeLinkAbility: false,
      });
  },
})

コールバック値を渡すかどうか

• コールバック値を渡さない場合、このリスナーのすべてのイベントコールバックが削除されます。以下のコードが例です。

  my.offSocketClose();

• コールバック値を渡す場合、対応するコールバックイベントのみが削除されます。以下のコードが例です。

  my.offSocketClose(this.callback);

my.rpc({
      operationType: 'com.xx.xx',
      requestData: [{
        "param1":"",
        "param2":0
      }],
      success: res => {
      },
      fail: res => {
      }
});