ชั้นเรียน: ช่างก่อสร้าง

gapi.cloudsearch.widget.searchbox.Builder

ชั้นเรียน   คงที่

เครื่องมือสร้างช่องค้นหา ใช้เครื่องมือสร้างและไม่ต้องเรียกใช้โดยตรง เครื่องมือสร้างช่องค้นหา

ผู้ผลิต

ช่างก่อสร้าง

ใหม่ ช่างก่อสร้าง

ตัวอย่าง

// Builds a search box.
function onload() {
  gapi.client.init({
    'apiKey': '<your api key>',
    'clientId': '<your client id>',
    // Add additional scopes if needed
    'scope': 'https://www.googleapis.com/auth/cloud_search.query',
    'hosted_domain': '<your G Suite domain>',
  });

  const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById('input'))
    .setAnchor(document.getElementById('input').parentElement)
    .build();
}
gapi.load('client:cloudsearch-widget', onload);

เมธอด

สร้าง

build() returns SearchBox

การคืนสินค้า

non-null SearchBox 

setAdapter

setAdapter(adapter) จะส่งคืน Builder

ต้องระบุ กำหนดประสบการณ์ในการค้นหาของผู้ใช้ด้วยอะแดปเตอร์นี้

พารามิเตอร์
อะแดปเตอร์	SearchBoxAdapter คุณอาจลบล้างบางส่วนของเมธอดได้ ค่าต้องไม่เป็นค่าว่าง

การคืนสินค้า

non-null Builder รายการนี้

ตัวอย่าง

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) จะแสดง Builder

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งสามารถมีรายการย่อยได้ จุดยึดของการวางซ้อนการค้นหา เพิ่มการวางซ้อนแล้ว เป็นเด็กคนสุดท้ายใน Anchor ตำแหน่งของโฆษณาซ้อนทับคือ ด้านล่างของจุดยึด

พารามิเตอร์
แท็ก Anchor	HTMLElement ค่าต้องไม่เป็นค่าว่าง

เลิกใช้

ใช้ "setAnchorElement" แทน

การคืนสินค้า

non-null Builder รายการนี้

setAnchorElement

setAnchorElement(anchorElement) แสดงเครื่องมือสร้าง

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งสามารถมีรายการย่อยได้ จุดยึดของการวางซ้อนการค้นหา เพิ่มการวางซ้อนแล้ว เป็นเด็กคนสุดท้ายใน Anchor ตำแหน่งของโฆษณาซ้อนทับคือ ด้านล่างของจุดยึด

พารามิเตอร์
anchorElement	HTMLElement ค่าต้องไม่เป็นค่าว่าง

การคืนสินค้า

non-null Builder รายการนี้

setHints

setHints(hints) จะแสดง Builder

ไม่บังคับ คำแนะนำที่ช่องค้นหาเมื่อไม่มีข้อมูล เมื่ออินพุตว่างเปล่า ระบบจะสุ่มเลือกจากอาร์เรย์

พารามิเตอร์
คำใบ้	อาร์เรย์ของสตริง ค่าต้องไม่เป็นค่าว่าง

การคืนสินค้า

non-null Builder รายการนี้

setInput

setInput(input) แสดงผล Builder

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนคำค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
อินพุต	HTMLElement ค่าต้องไม่เป็นค่าว่าง

เลิกใช้

ใช้ "setInputElement" แทน

การคืนสินค้า

non-null Builder รายการนี้

setInputElement

setInputElement(inputElement) returns Builder

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนคำค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
inputElement	HTMLElement ค่าต้องไม่เป็นค่าว่าง

การคืนสินค้า

non-null Builder รายการนี้

setResultsContainer

setResultsContainer(resultsContainer) แสดงผล Builder

ไม่บังคับ คอนเทนเนอร์สำหรับแสดงผลการค้นหา หากตั้งค่าไว้ ผลลัพธ์จะแสดงในคอนเทนเนอร์ผลการค้นหา หากไม่ได้ตั้งค่า ผลลัพธ์จะแสดงใน cloudsearch.google.com

พารามิเตอร์
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer ค่าต้องไม่เป็นค่าว่าง

ดูเพิ่มเติม

ResultsContainer

การคืนสินค้า

non-null Builder รายการนี้

setSearchApplicationId

setSearchApplicationId(searchApplicationId) ส่งคืน Builder

ไม่บังคับ ตั้งค่ารหัสแอปพลิเคชันการค้นหาที่จะใช้สำหรับคำขอ ต้อง จะมี "searchapplications/" นำหน้า

พารามิเตอร์
searchApplicationId	สตริง

การคืนสินค้า

non-null Builder รายการนี้

setThrottleInterval

setThrottleInterval(throttleInterval) แสดงผล Builder

ไม่บังคับ ช่วงเวลาการควบคุมในหน่วยมิลลิวินาทีสำหรับคำขอเริ่มทำงาน ช่องค้นหาจะส่งคำขอน้อยกว่า 1 คำขอทุกๆ throttleInterval มิลลิวินาที หาก throttleinternal น้อยกว่า 200 ช่องค้นหาจะไม่สนใจ และใช้ 200 เป็นช่วงเวลาแทน

พารามิเตอร์
throttleInterval	ตัวเลข

การคืนสินค้า

non-null Builder รายการนี้