Skip to main content

Genel bakış

Bir sohbet arayüzü görüntüleyen bir kullanıcı arayüzü öğesi.

Kullanım

Temel kullanım

Olayları dinleme

Olaylar

ChatElement tarafından yayılan olaylar. Bu olayları on() metodunu kullanarak veya seçeneklerde geri çağırma fonksiyonları geçirerek dinleyin.

error

Öğenin başlatılması veya çalışması sırasında bir hata oluştuğunda yayılır. Geri çağırma imzası: (error: unknown) => void

ready

Öğe yüklemeyi tamamladığında ve kullanıcı etkileşimine hazır olduğunda yayılır. Geri çağırma imzası: (element: ChatElement) => void

optionsUpdated

Öğenin seçenekleri updateOptions() aracılığıyla güncellendiğinde yayılır. Geri çağırma imzası: (options: ChatElementOptions) => void

snapshot

Öğenin dahili durumu değiştiğinde yayılır. Geri çağırma imzası: (snapshot: ChatElementSnapshot) => void

profileClick

Kullanıcı bir profile tıkladığında yayılır. Geri çağırma imzası: (ev: CustomEvent<{ id: string; }>) => void

linkClick

Kullanıcı bir bağlantıya tıkladığında yayılır. Geri çağırma imzası: (ev: CustomEvent<{ url: string; }>) => void

messageSent

Kullanıcı bir mesaj gönderdiğinde yayılır. Geri çağırma imzası: (ev: CustomEvent<{ id: string; content: string; channelId: string; }>) => void

messageDeleted

Kullanıcı bir mesajı sildiğinde yayılır. Geri çağırma imzası: (ev: CustomEvent<{ id: string; }>) => void

experienceClick

Kullanıcı bir deneyim bahsine tıkladığında yayılır. Geri çağırma imzası: (ev: CustomEvent<{ id: string; }>) => void

attachmentClick

Kullanıcı bir eke tıkladığında yayılır. Geri çağırma imzası: (ev: CustomEvent<{ messageId: string; attachments: AttachmentClickEventAttachment[]; }>) => void

Metodlar

mount(container)

Öğeyi bir DOM kapsayıcısına yerleştirir. Kapsayıcı boş bir öğe olmalıdır. Öğe, alt öğe olarak eklenir. Öğe zaten yerleştirilmişse, bu metod bir uyarı kaydeder ve geri döner.

unmount()

Öğeyi DOM’dan kaldırır ve tüm olay dinleyicilerini temizler. Kaldırıldıktan sonra öğe örneği yeniden kullanılmamalıdır. Yeniden yerleştirmeniz gerekirse yeni bir öğe örneği oluşturun.

updateOptions(options)

Oluşturulduktan sonra öğenin yapılandırma seçeneklerini günceller. Yalnızca sağlanan seçenekler güncellenir; diğer seçenekler değişmeden kalır. Öğe yeni seçeneklerle yeniden işlenir.

getSnapshot()

Öğenin mevcut durum anlık görüntüsünü alır. Anlık görüntü, yükleme durumu, form değerleri veya öğeye özgü diğer veriler gibi öğenin mevcut dahili durumunu içerir. Döndürür: ChatElementSnapshot

Stil

Bu öğeyi appearance.classes ile özelleştirin. Kararlı sınıf adlarının tam listesi ve örnek kod parçacıkları için stil referansına bakın.

Türler

ChatElementOptions

ChatElement için yapılandırma seçenekleri.

ChatElementSnapshot

ChatElement’in mevcut durumunu temsil eder. Mevcut durumu almak için element.getSnapshot() kullanın veya değişiklikler için snapshot olayını dinleyin.