Objek Permintaan

[Microsoft Agent tidak digunakan lagi pada Windows 7, dan mungkin tidak tersedia dalam versi Windows berikutnya.]

Server memproses beberapa metode secara asinkron. Ini memungkinkan kode aplikasi Anda untuk melanjutkan saat metode selesai. Ketika aplikasi klien memanggil salah satu metode ini, kontrol membuat dan mengembalikan objek Permintaan untuk permintaan tersebut. Anda dapat menggunakan objek Permintaan untuk melacak status metode dengan menetapkan variabel objek ke metode . Di Visual Basic, pertama-tama deklarasikan variabel objek:

   Dim MyRequest as Object

Di VBScript, Anda tidak menyertakan jenis variabel dalam deklarasi Anda:

   Dim MyRequest

Dan gunakan pernyataan Set Visual Basic untuk menetapkan variabel ke panggilan metode:

   Set MyRequest = <i>agent</i>.Characters("<i>CharacterID</i>").<i>method</i> (<i>parameter</i>[s])

Ini menambahkan referensi ke objek Permintaan . Objek Permintaan akan dihancurkan ketika tidak ada lagi referensi untuk itu. Tempat Anda mendeklarasikan objek Permintaan dan cara Anda menggunakannya menentukan masa pakainya. Jika objek dinyatakan lokal ke subroutine atau fungsi, objek akan dihancurkan ketika keluar dari cakupan; yaitu, ketika subroutine atau fungsi berakhir. Jika objek dideklarasikan secara global, objek tidak akan dihancurkan sampai program berakhir atau nilai baru (atau nilai yang diatur ke "kosong") ditetapkan ke objek.

Objek Permintaan menyediakan beberapa properti yang bisa Anda kueri. Misalnya, properti Status mengembalikan status permintaan saat ini. Anda dapat menggunakan properti ini untuk memeriksa status permintaan Anda:

   Dim MyRequest
   
   Set MyRequest = Agent1.Characters.Load ("Genie", "https://agent.microsoft.com/characters/v2/genie/genie.acf")

   If (MyRequest.Status = 2) then
      'do something

   Else If (MyRequest.Status = 0) then
      'do something right away

   End If

Properti Status mengembalikan status objek Permintaan sebagai nilai Bilangan Bulat panjang.

Status	Definisi
0	Permintaan berhasil diselesaikan.
1	Permintaan gagal.
2	Permintaan tertunda (dalam antrean, tetapi tidak selesai).
3	Permintaan terganggu.
4	Permintaan sedang berlangsung.

 

Objek Permintaan juga menyertakan nilai Bilangan bulat Panjang dalam properti Angka yang mengembalikan kesalahan atau penyebab kode Status . Jika tidak ada, nilai ini adalah nol (0). Properti Deskripsi berisi nilai string yang sesuai dengan nomor kesalahan. Jika string tidak ada, Deskripsi berisi "Kesalahan yang ditentukan aplikasi atau yang ditentukan objek".

Untuk nilai dan arti yang dikembalikan oleh properti Angka , lihat Kode Kesalahan.

Server menempatkan permintaan animasi dalam antrean karakter yang ditentukan. Ini memungkinkan server untuk memutar animasi pada utas terpisah, dan kode aplikasi Anda dapat dilanjutkan saat animasi diputar. Jika Anda membuat referensi objek Permintaan , server secara otomatis memberi tahu Anda ketika permintaan animasi telah dimulai atau diselesaikan melalui peristiwa RequestStart dan RequestComplete . Karena metode yang mengembalikan objek Permintaan tidak sinkron dan mungkin tidak selesai selama cakupan fungsi panggilan, nyatakan referensi Anda ke objek Permintaan secara global.

Metode berikut dapat digunakan untuk mengembalikan objek Permintaan : GestureAt, Get, Hide, Interrupt, Load, MoveTo, Play, Show, Speak, dan Wait.