Eklenti işlemleri, widget'lara etkileşimli davranışlar sağlar. Bir işlem oluşturarak kullanıcı bir widget'ı seçtiğinde veya güncellediğinde ne olacağını tanımlarsınız.
Çoğu durumda, Google Apps Komut Dosyası Card hizmeti tarafından sağlanan
Action
nesnelerini kullanarak eklenti işlemlerini tanımlayabilirsiniz.
Her Action, oluşturduğunuzda bir geri çağırma işleviyle ilişkilendirilir. Kullanıcı widget'la etkileşimde bulunduğunda belirli adımları uygulamak için geri çağırma işlevini uygularsınız. Ayrıca, Action öğesini, Action geri çağırmasını hangi etkileşim türünün tetiklediğini tanımlayan uygun bir widget işleyici işlevi kullanarak widget'a bağlamanız gerekir.
Bu işlemi kullanarak Action içeren bir widget yapılandırın:
Actionnesnesini oluşturun. Bu nesnenin, gerektirdiği parametrelerle birlikte yürüteceği geri çağırma işlevini belirtin.Actionnesnesini kullanarak widget'ta uygun widget işleyici işlevini çağırın.- Gerekli davranışı etkinleştirmek için geri çağırma işlevini uygulayın.
Action nesneleri CardAction nesnelerle karıştırmayın. CardAction nesneleri kart üstbilgisi menü öğeleridir. Action nesneleri ise kullanıcı arayüzüyle etkileşimlere verilen yanıtları tanımlar.
Widget işleyici işlevleri
Bir widget'ı Action veya başka bir davranışa bağlamak için widget işleyici işlevini kullanın. İşleyici işlevi, hangi etkileşim türünün (örneğin, widget'ı tıklama veya bir metin alanını düzenleme) işlem davranışını tetiklediğini belirler. İşleyici işlevi, işlem tamamlandıktan sonra kullanıcı arayüzünün hangi adımları uygulayacağını da tanımlar.
Aşağıdaki tabloda, widget'lar için farklı işleyici türleri ve hangi widget'larla kullanıldıkları listelenmiştir:
| İşleyici işlevi | İşlemi tetikler | Geçerli widget'lar | Açıklama |
|---|---|---|---|
setOnChangeAction |
Widget değeri değiştiğinde |
DatePicker
DateTimePicker
SelectionInputSwitch
TextInput
TimePicker
|
Kullanıcı bir girişe metin girip Enter tuşuna bastığında olduğu gibi, widget odağını kaybettiğinde Apps Komut Dosyası işlevini yürüten bir Action
ayarlar. İşleyici, çağırdığı işleve otomatik olarak bir etkinlik nesnesi iletir.
Seçilirse bu etkinlik nesnesine ek parametre bilgileri ekleyebilirsiniz. |
setOnClickAction |
Kullanıcı widget'ı tıkladığında |
CardActionImageImageButtonDecoratedTextTextButton
|
Kullanıcı widget'ı tıkladığında bir Apps Komut Dosyası işlevini yürüten bir Action
ayarlar. İşleyici, çağırdığı işleve otomatik olarak bir etkinlik nesnesi iletir.
Bu etkinlik nesnesine isteğe bağlı parametre bilgileri ekleyebilirsiniz. |
setComposeAction |
Kullanıcı widget'ı tıkladığında |
CardActionImageImageButtonDecoratedTextTextButton
|
Gmail'e özel. E-posta taslağı oluşturan ve bu taslağı Gmail kullanıcı arayüzü yazma penceresinde kullanıcıya sunan bir Action ayarlar. Taslağı yeni bir ileti olarak veya Gmail'de açık olan iletiye yanıt olarak oluşturabilirsiniz. İşleyici, taslak oluşturma geri çağırma işlevini çağırdığında geri çağırma işlevine bir etkinlik nesnesi iletir.
Daha fazla bilgi için
Taslak mesaj oluşturma
bölümüne bakın. |
setOnClickOpenLinkAction |
Kullanıcı widget'ı tıkladığında |
CardActionImageImageButtonDecoratedTextTextButton
|
Kullanıcı widget'ı tıkladığında bir URL'nin açılması için Action ayarlar. URL'yi oluşturmanız gerektiğinde veya bağlantı açılmadan önce başka işlemlerin yapılması gerektiğinde bu işleyiciyi kullanın. Aksi takdirde, genellikle setOpenLink öğesini kullanmak daha basittir.
URL'yi yalnızca yeni bir pencerede açabilirsiniz. Kapatıldığında, kullanıcı arayüzünün eklentiyi yeniden yüklemesine neden olabilirsiniz. |
setOpenLink |
Kullanıcı widget'ı tıkladığında |
CardActionImageImageButtonDecoratedTextTextButton
|
Kullanıcı widget'ı tıkladığında doğrudan bir URL açar. URL'yi biliyorsanız ve yalnızca açmanız gerekiyorsa bu işleyiciyi kullanın. Aksi takdirde setOnClickOpenLinkAction işleyicisini kullanın.
URL'yi yeni bir pencerede veya yer paylaşımında açabilirsiniz. Kapatıldığında, kullanıcı arayüzünün eklentiyi yeniden yüklemesine neden olabilirsiniz. |
setSuggestionsAction |
Kullanıcı bir girişe metin girer |
TextInput
|
Kullanıcı bir metin girişi widget'ına metin girdiğinde bir Apps Komut Dosyası işlevini yürüten Action
ayarlar. İşleyici, çağırdığı işleve otomatik olarak bir etkinlik nesnesi iletir.
Daha fazla bilgi için Metin girişleri için otomatik tamamlama önerileri başlıklı makaleyi inceleyin. |
Geri çağırma işlevleri
Geri çağırma işlevleri, bir Action tetiklendiğinde yürütülür. Geri çağırma işlevleri Apps Komut Dosyası işlevleri olduğundan, diğer komut dosyası işlevlerinin yapabildiği neredeyse her şeyi yapabilirler.
Geri çağırma işlevi bazen belirli bir yanıt nesnesi döndürür. Bu tür yanıtlar, geri çağırma işlemi tamamlandıktan sonra yapılması gereken ek işlemleri (ör. yeni bir kart gösterme veya otomatik tamamlama önerileri sunma) belirtir. Geri çağırma işleviniz belirli bir yanıt nesnesi döndürmesi gerektiğinde bu nesneyi oluşturmak için Card service içinde bir oluşturucu sınıfı kullanırsınız.
Aşağıdaki tabloda, geri çağırma işlevlerinizin belirli işlemler için ne zaman belirli bir yanıt nesnesi döndürmesi gerektiği gösterilmektedir. Bu işlemlerin tümü, eklentinin genişlettiği belirli ana makine uygulamasından bağımsızdır:
| Denenen işlem | Geri çağırma işlevi döndürmelidir |
|---|---|
| Gezinme | ActionResponse |
Notification görüntüleme |
ActionResponse |
setOnClickOpenLinkAction kullanarak bağlantı açma |
ActionResponse |
| Otomatik tamamlama önerilerini görüntüleme | SuggestionResponse |
| Evrensel işlem kullanma | UniversalActionResponse |
| Diğer işlemler | Nothing |
Google Workspace ana makine uygulamaları için işlemler
Bu işlemlere ek olarak, her ana makine uygulamasının, yalnızca o ana makinede gerçekleştirilebilecek kendi işlem grubu vardır. Ayrıntılar için aşağıdaki kılavuzlara bakın:
Yanıt oluşturucu sınıflarını kullanırken build yöntemini çağırarak yanıt nesnelerini oluşturun. Aksi takdirde hata oluşur.
Evrensel işlemler, proje manifestinde tanımlanır ve Action nesnelerine ihtiyaç duymaz ancak geri çağırma işlevleri UniversalActionResponse döndürmelidir.
İşlem etkinliği nesneleri
Eklentiniz bir Action tetiklediğinde kullanıcı arayüzü otomatik olarak bir JSON etkinlik nesnesi oluşturur ve bunu Action geri çağırma işlevine bağımsız değişken olarak iletir. Bu etkinlik nesnesi, kullanıcının mevcut istemci tarafı bağlamıyla ilgili bilgileri (ör. görüntülenen karttaki tüm etkileşimli widget'ların mevcut değerleri) içerir.
İşlem etkinliği nesneleri, içerdiği bilgileri düzenleyen belirli bir JSON yapısına sahiptir. Aynı yapı, bir ana sayfa oluşturmak için ana sayfa tetikleyicisi tetiklendiğinde veya eklenti ekranını güncellemek için bağlama dayalı tetikleyici tetiklendiğinde kullanılır.
Etkinlik nesnesi yapısının tam açıklaması için Etkinlik nesneleri bölümüne bakın.
Gmail eklentileri, bu etkinlik nesnesi yapısının basitleştirilmiş bir sürümünü kullanıyordu. Bu sürüm artık desteği sonlandırılmış. Geriye dönük uyumluluk için orijinal Gmail eklentileri etkinlik nesnesi alanlarının tümü yeni etkinlik nesnesi yapısında yer almaya devam eder (bkz. etkinlik nesnesi yapısı).
Ancak aynı bilgiler commonEventObject ve Gmail etkinliği nesnesi alt yapılarında yeniden üretilir. Gmail eklentisini Google Workspace eklentisine yükseltiyorsanız güncellenen etkinlik nesnesi alanlarını kullanmak için kodunuzu ayarlayın. Orijinal Gmail etkinlik nesnesi alanları sonunda kaldırılır.