Flutter SDK referansı

Günlük hayatta kullandığınız genel API. Kendinizi src/ dizininden içe aktarma yaparken bulursanız neye ihtiyaç duyduğunuzu bize bildirin, onu uygun şekilde dışa aktaralım.

Oluşturulan tam dartdoc, yayımlanan ilk sürümle birlikte pub.dev'de yerini alacaktır. Bu sayfa ise yol haritasıdır.

Bu çağrıları nadiren kendiniz yazarsınız: her görev, bunları yapay zekâ kodlama aracınıza yazdıran istemle başlar. Bu sayfa, onların dayandığı temeldir.

Rendel

Ön yüz (facade). Uygulama çalıştırması başına bir init.

RendelConfig

Protokolün değil, sizin tercihiniz olan her şey. Her alan, aynı zamanda yönetim panelinden yayımlanan her şey için taban değerdir.

RendelAction

Rendel'in yapmasına izin verilenler.

Rendel.registerAction(RendelAction(
  name: 'add_to_cart',
  description: 'Add a product to the cart',
  params: RendelSchema.object({
    'product_id': RendelSchema.string(),
    'quantity': RendelSchema.integer(),
  }),
  risk: RendelRisk.write,
  confirmTemplate: 'Add {quantity} to your cart?',
  editable: ['quantity'],
  handler: (params) async => RendelResult.ok(await cart.add(params)),
));

RendelSchema

JSON Schema'yı elle yazmadan parametre biçimleri.

RendelSchema.object({
  'order_id': RendelSchema.string(description: 'The order number'),
  'reason': RendelSchema.enumOf(['damaged', 'wrong_item', 'other']).optional,
  'quantity': RendelSchema.integer().optional,
  'tags': RendelSchema.list(RendelSchema.string()),
})

string, number, integer, boolean, enumOf, list, object ve yardımcı işlevlerin kapsamadığı her şey için raw. Herhangi birinde .optional (veya .orAbsent).

RendelResult

RendelResult.ok(Map<String, dynamic> data) veya RendelResult.fail(String error). Başarısızlık dizesi modele ulaşır, bu yüzden modeli harekete geçirebilecek bir ifade olarak yazın: “bu numaraya sahip sipariş yok” ifadesi “404”ten daha iyidir.

RendelRisk

read, write, destructive. Bkz. aksiyonlar ve risk seviyeleri.

RendelInvocation

id, name, params, risk. id, aynı turun yeniden denenmesinde kararlıdır; dolayısıyla işleyicinizin yaptığı her işlem için doğal bir tekilleştirme anahtarıdır.

Bir aksiyonu iki kez çalıştırmak hiç çalıştırmamaktan daha kötü olacağı durumlarda bunu onInvoke ile alın: işleyiciyi çalıştırmak ile sonucu bildirmek arasında sonlandırılan bir uygulama, sunucuyu sonuçsuz bırakır ve model aynı şeyi tekrar önerebilir.

Rendel.registerAction(RendelAction(
  name: 'refund_order',
  description: 'Refund an order to the original payment method',
  params: RendelSchema.object({'order_id': RendelSchema.string()}),
  risk: RendelRisk.destructive,
  confirmTemplate: 'Refund order {order_id}? This cannot be undone.',
  onInvoke: (invocation) async {
    // The same id comes back if the turn is resumed after a dropped stream.
    if (await refunds.alreadyProcessed(invocation.id)) {
      return RendelResult.ok({'status': 'already_refunded'});
    }
    return RendelResult.ok(await refunds.create(
      orderId: invocation.params['order_id'] as String,
      idempotencyKey: invocation.id,
    ));
  },
));

RendelRouteParam

Her biri description, required ve fromActions alan RendelRouteParam.string(), .number(), .boolean(). fromActions: true ile değer, bu sohbette bir aksiyonun döndürdüğü bir değer olmalıdır; böylece tahmin edilen bir sipariş kimliği ekranı asla açamaz.

Rendel.registerRoute(
  'order_detail',
  title: 'My orders › Order',
  description: 'One order: its items, delivery and payment.',
  params: {'order_id': RendelRouteParam.string(required: true, fromActions: true)},
  open: (p) => navigatorKey.currentState!.pushNamed('/orders/${p['order_id']}'),
);

open, bir RendelRouteOpener olup (FutureOr<void> Function(Map<String, Object?> params)) sunucunun denetlediği parametreleri alır.

RendelLauncher

RendelLauncher({String? label}). Rendel başlatılmadığında veya devre dışı bırakıldığında hiçbir şey çizmez, böylece onu ağaçta koşulsuz olarak bırakabilirsiniz. Ayrıca, açtığı bir ekran için ileti dizisi baloncuğuna küçüldüğünde kenara çekilir; çünkü o durumda geri dönüş yolu baloncuktur: ekranda aynı anda yalnızca tek bir giriş yolu olur. Kendinize ait bir düğme de Rendel.minimised (ValueListenable<bool>) dinleyerek aynısını yapar.

RendelTheme

Bkz. Temalandırma. Dört renginize güvenmek yerine okunabilir metin ve kenarlık rollerini türeten RendelTheme.fromTokens(...) ile oluşturulur — bunu yapmayan temalanabilir bir SDK, okunaksız rozetler sunar.

RendelTheme.paper() ve RendelTheme.deep() iki yerleşik temadır; fromTokens(...) sizinkini oluşturur. RendelThemeScope.of(context) özel bir bileşen içinde temayı okur. contrastRatio ve auditContrast renklerinizi denetler.

RendelConfigStore

abstract class RendelConfigStore {
  Future<String?> read();
  Future<void> write(String value);
}

Tek arayüz, iki kullanım: RendelConfig.configStore ve RendelConfig.deviceIdStore. Varsayılan olarak her ikisi de uygulamanın tercihlerinde (shared_preferences) tutulur. RendelMemoryConfigStore bellek içi seçenektir ve flutter test altında varsayılandır.

RendelLogRecord, RendelLogLevel, RendelLog

SDK'nın size başka bir yolla söyleyemediği şeyleri bildirdiği yer.

code kararlıdır ve üzerinde switch çalıştırmak güvenlidir; message insanlar içindir ve yeniden ifade edilebilir.

RendelEvent

opened, closed, messageSent, actionExecuted. Kendi analitiğiniz için.

Kendi bileşeninizi render etme

ComponentRegistry.register(String type, ComponentBuilder builder), kataloğun yerine sizin bir widget'ınızı koyar. ComponentBuilder, Widget Function(BuildContext context, WireBlock block, RendelDispatcher dispatch) şeklindedir. RendelActionButton, RendelChip, RendelControlShell, RendelOverline, RendelPressable, RendelPulse ve RendelSwap, bileşeninizin Material gibi değil, yerleşik bir bileşen gibi basılması, sarılması ve nefes alması için dışa aktarılmıştır.

RendelDispatcher

Bileşeninizin nasıl geri bildirim verdiği. SDK, oluşturucunuza bir tane iletir; bunu asla kendiniz yapılandırmazsınız. Null olan bir üye, bu derlemenin bunu yapamayacağı anlamına gelir; bu yüzden o kısmı içerik olarak çizin.

UIAction

Kapalı birleşim (sealed union): ReplyAction, OpenUrlAction, NavigateAction, CallAction, EmailAction, CopyAction, AddToCalendarAction, ConfirmAction, CancelAction, AppActionRef. Yeni türler ara sürümlerde eklenir; bu nedenle üzerindeki her switch ifadesine bir joker (_ =>) durumu ekleyin.

0.32.0 öncesinden kalan adlar

Her NC*, NeonCopilot ve Copilot* adı, Rendel* ikamesinin desteği sonlandırılmış (deprecated) bir typedef'idir ve her biri 1.0 sürümünde kaldırılacaktır.