Mobile Platform as a Service：Jaringan

my.request

Melakukan permintaan jaringan dari miniapp.

• API my.request saat ini mendukung metode GET, POST, dan DELETE.

• API my.request saat ini hanya mendukung permintaan HTTPS.

Untuk informasi selengkapnya, lihat FAQ my.request.

Catatan penggunaan:

• Aktifkan Permission control switch di Release Mini Program > Open Platform Mini Program Management. Kemudian, konfigurasikan daftar putih nama domain di Server domain name whitelist. Miniapp hanya dapat berkomunikasi dengan nama domain yang ada dalam daftar putih saat memanggil API seperti permintaan HTTP (my.request) dan unggah file (my.uploadFile).

• Setelah Anda menambahkan nama domain ke daftar putih server, Anda harus mengemas ulang, mengunggah, dan membuat versi uji agar perubahan tersebut berlaku.

• Saat melakukan debug di IDE, gunakan perangkat nyata untuk pratinjau.

Parameter input

Deskripsi parameter data

Data yang dikirim ke server pada akhirnya dikonversi menjadi string. Jika data bukan string, maka dikonversi berdasarkan aturan berikut:

• Jika metodenya adalah GET, data dikonversi menjadi string kueri: encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)....

• Jika metodenya adalah POST dan headers['content-type'] bernilai application/json, data diserialisasi ke JSON.

• Jika metodenya adalah POST dan headers['content-type'] bernilai application/x-www-form-urlencoded, data dikonversi menjadi string kueri: encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)....

Deskripsi referer

• Anda tidak dapat mengatur header referer pada permintaan jaringan.

• Formatnya tetap sebagai https://urlhost/{appid}/{version}/page-frame.html, di mana {appid} adalah APPID miniapp dan {version} adalah nomor versi miniapp.

Nilai kembali success

Kode kesalahan

Jika pemanggilan my.request mengembalikan You are not authorized to call this interface, konfigurasikan daftar putih nama domain di Open Platform Mini Program Management > Server domain name whitelist.

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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'});
  }
});

// Mengembalikan RequestTask, yang memungkinkan Anda memanggil metode abort untuk membatalkan permintaan.
const task = my.request({url: 'https://example.org/post'})
task.abort()

Nilai kembali

RequestTask

Objek tugas permintaan jaringan.

Metode

RequestTask.abort()

my.uploadFile

Mengunggah resource lokal ke server developer.

Catatan penggunaan:

• Konfigurasikan daftar putih nama domain di Open Platform Mini Program Management > Server Domain Name Whitelist. Miniapp hanya dapat berkomunikasi dengan nama domain yang ada dalam daftar putih saat memanggil API seperti permintaan HTTP (my.request) dan unggah file (my.uploadFile).

Parameter input

Nilai kembali success

Kode kesalahan

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

my.uploadFile({
  url: 'Gunakan alamat server Anda sendiri',
  fileType: 'image',
  fileName: 'file',
  filePath: '...',
  success: (res) => {
    my.alert({
      content: 'Upload berhasil'
    });
  },
});

UploadTask

Objek yang mendengarkan perubahan progres unggah dan membatalkan tugas unggah.

Metode

Contoh kode

const task = my.uploadFile({
  url: 'Gunakan alamat server Anda sendiri',
  fileType: 'image',
  fileName: 'file',
  filePath: '...',
});
task.onProgressUpdate(({progress, totalBytesWritten, totalBytesExpectedToWrite}) => {
})
task.abort()

FAQ

• Q: Apakah miniapp dapat secara otomatis mengonversi gambar yang diunggah ke Base64, yaitu metode merepresentasikan data biner dengan karakter yang dapat dicetak?

  A: Tidak, miniapp tidak mendukung konversi gambar ke Base64.

• Q: Bagaimana cara menggunakan my.uploadFile untuk mengambil pesan kesalahan yang dikembalikan dari server?

  A:

  • Ambil dari parameter `data` dalam callback `success`.

  • Tambahkan API pengambilan log di sisi server. Jika unggah gagal, panggil API pengambilan log untuk mendapatkan log kegagalan secara detail.

• Q: Berapa timeout default untuk my.uploadFile? Apakah timeout default dapat diperpanjang?

  A: Timeout default untuk my.uploadFile adalah 30 detik. Tidak, Anda tidak dapat memperpanjang timeout default tersebut.

• Q: Mengapa my.uploadFile melaporkan error: 12 saat mengunggah file?

  A: Kode kesalahan 12 menunjukkan kegagalan unggah. Kemungkinan penyebab kegagalan meliputi:

  • File terlalu besar.

  • Unggah memakan waktu lebih dari 30 detik.

  • Tidak ada izin.

• Q: Backend menerima gambar biner saat menggunakan my.uploadFile. Jika backend mengirim kembali gambar biner ini ke miniapp, bagaimana miniapp menguraikannya?

  A: Backend menerima gambar sebagai aliran biner. Backend hanya perlu menyediakan URL lokasi gambar di server.

• Q: Mengapa pemanggilan my.uploadFile melaporkan error: 4, tidak ada izin untuk memanggil API ini?

  A: URL yang diminta tidak ada dalam daftar putih. Tambahkan nama domain URL tersebut ke daftar putih.

• Q: Apakah miniapp mendukung unggah file Excel?

  A: Tidak. Saat ini, my.uploadFile hanya mendukung unggah file bertipe image, video, atau audio. Tipe file lain tidak didukung.

• Q: Apakah my.uploadFile mendukung unggah beberapa gambar sekaligus?

  A: Tidak, my.uploadFile tidak mendukung unggah beberapa gambar sekaligus. Anda hanya dapat mengunggah satu gambar dalam satu waktu.

my.downloadFile

Mengunduh resource file ke perangkat lokal.

Parameter input

Nilai kembali success

Kode kesalahan

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

// 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">Unduh dan tampilkan gambar</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

Membuat koneksi WebSocket.

Miniapp hanya dapat memiliki satu koneksi WebSocket dalam satu waktu. Jika koneksi WebSocket sudah ada, koneksi tersebut akan ditutup secara otomatis, dan koneksi baru dibuat.

Parameter input

Kode kesalahan

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

my.onSocketOpen

Mendengarkan event pembukaan koneksi WebSocket.

Parameter input

Tipe Object dengan properti berikut:

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

my.onSocketOpen(function(res) {
  console.log('Koneksi WebSocket terbuka!');
});

my.offSocketOpen

Berhenti mendengarkan event pembukaan koneksi WebSocket.

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

Apakah perlu melewatkan nilai callback

• Jika Anda tidak melewatkan nilai callback, semua callback event untuk listener ini akan dihapus. Contoh kode berikut:

  my.offSocketOpen();

• Jika Anda melewatkan nilai callback, hanya event callback yang sesuai yang dihapus. Contoh kode berikut:

  my.offSocketOpen(this.callback);

my.onSocketError

Mendengarkan kesalahan WebSocket.

Parameter input

Tipe Object dengan properti berikut:

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

my.connectSocket({
  url: 'Alamat server Anda'
});

my.onSocketOpen(function(res){
  console.log('Koneksi WebSocket terbuka!');
});

my.onSocketError(function(res){
  console.log('Koneksi WebSocket gagal. Silakan periksa!');
});

my.offSocketError

Berhenti mendengarkan kesalahan WebSocket.

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

Apakah perlu melewatkan nilai callback

• Jika Anda tidak melewatkan nilai callback, semua callback event untuk listener ini akan dihapus. Contoh kode berikut:

  my.offSocketError();

• Jika Anda melewatkan nilai callback, hanya event callback yang sesuai yang dihapus. Contoh kode berikut:

  my.offSocketError(this.callback);

my.sendSocketMessage

Mengirim data melalui koneksi WebSocket. Anda harus terlebih dahulu menggunakan my.connectSocket untuk memulai koneksi, lalu mengirim data setelah callback my.onSocketOpen.

Parameter input

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

my.sendSocketMessage({
    data: this.data.toSendMessage, // Konten yang akan dikirim
    success: (res) => {
        my.alert({content: 'Data terkirim! ' + this.data.toSendMessage});
    },
});

my.onSocketMessage

Mendengarkan pesan yang diterima dari server melalui koneksi WebSocket.

Nilai kembali callback

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

my.connectSocket({
  url: 'Alamat server'
})

my.onSocketMessage(function(res) {
  console.log('Menerima konten dari server: ' + res.data)
})

my.offSocketMessage

Berhenti mendengarkan pesan yang diterima dari server melalui koneksi WebSocket.

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

my.connectSocket({
  url: 'Alamat server'
})
my.onSocketMessage(function(res) {
  console.log('Menerima konten dari server: ' + res.data)
})
my.offSocketMessage();

Apakah perlu melewatkan nilai callback

• Jika Anda tidak melewatkan nilai callback, semua callback event untuk listener ini akan dihapus. Contoh kode berikut:

  my.offSocketMessage();

• Jika Anda melewatkan nilai callback, hanya event callback yang sesuai yang dihapus. Contoh kode berikut:

  my.offSocketMessage(this.callback);

my.closeSocket

Menutup koneksi WebSocket.

Parameter input

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

my.onSocketClose(function(res) {
  console.log('Koneksi WebSocket ditutup!')
})

my.onSocketClose

Mendengarkan event penutupan WebSocket.

Parameter input

Tipe Object dengan properti berikut:

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

onLoad() {
    // Catatan: Daftarkan metode callback hanya sekali selama fase startup miniapp.
    // Jika Anda memanggilnya beberapa kali, callback akan dipicu beberapa kali.
    my.onSocketClose((res) => {
      my.alert({content: 'Koneksi ditutup!'});
      this.setData({
        sendMessageAbility: false,
        closeLinkAbility: false,
      });
    });
    // Catatan: Daftarkan metode callback hanya sekali selama fase startup miniapp.
    // Jika Anda memanggilnya beberapa kali, callback akan dipicu beberapa kali.
    my.onSocketOpen((res) => {
      my.alert({content: 'Koneksi dibuka!'});
      this.setData({
        sendMessageAbility: true,
        closeLinkAbility: true,
      });
    });

    my.onSocketError(function(res){
      my.alert('Koneksi WebSocket gagal. Silakan periksa! ' + res);
    });

    // Catatan: Daftarkan metode callback hanya sekali selama fase startup miniapp.
    // Jika Anda memanggilnya beberapa kali, callback akan dipicu beberapa kali.
    my.onSocketMessage((res) => {
      my.alert({content: 'Data diterima! ' + JSON.stringify(res)});
    });
  }

connect_start() {
    my.connectSocket({
      url: 'Alamat server', // Alamat API server developer. Harus menggunakan protokol wss, dan nama domain harus berupa nama domain resmi yang dikonfigurasi di backend.
      success: (res) => {
        my.showToast({
          content: 'success', // Konten teks
        });
      },
      fail:()=>{
        my.showToast({
          content: 'fail', // Konten teks
        });
      }
    });
  },

my.offSocketClose

Berhenti mendengarkan event penutupan WebSocket.

Contoh kode

Contoh ini hanya sebagai referensi. Anda harus menggunakan alamat Anda sendiri untuk pengujian.

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

Apakah perlu melewatkan nilai callback

• Jika Anda tidak melewatkan nilai callback, semua callback event untuk listener ini akan dihapus. Contoh kode berikut:

  my.offSocketClose();

• Jika Anda melewatkan nilai callback, hanya event callback yang sesuai yang dihapus. Contoh kode berikut:

  my.offSocketClose(this.callback);

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