UploadTask interface

Bir nesne yükleme işlemini temsil eder. Yüklemeyi izlemenize ve yönetmenize olanak tanır.

İmza:

export interface UploadTask

Özellikler

Özellik Tür Açıklama
anlık görüntü UploadTaskSnapshot Mevcut görev durumunun anlık görüntüsü.

Yöntemler

Yöntem Açıklama
cancel() Çalışan bir görevi iptal eder. Tamamlanmış veya başarısız bir görev üzerinde hiçbir etkisi yoktur.
catch(onReddedildi) then(null, onRejected) çağrısına eşdeğerdir.
on(event, nextOrObserver, error, complete) Bu görevdeki etkinlikleri işler.Etkinliklerin üç geri çağırma işlevi vardır (next, error ve complete olarak anılır).Yalnızca etkinlik iletilirse geri çağırmaları kaydetmek için kullanılabilecek bir işlev döndürülür. Aksi takdirde, geri çağırmalar etkinlikten sonra iletilir.Geri çağırmalar üç ayrı bağımsız değişken olarak veya bir nesnenin next, error ve complete özellikleri olarak iletilebilir. En az biri belirtildiği sürece üç geri çağırmatan herhangi biri isteğe bağlıdır. Ayrıca, geri aramalarınızı eklediğinizde bir işlev de geri alırsınız. İlişkili geri çağırmaların kaydını silmek için bu işlevi çağırabilirsiniz.
pause() Çalışmakta olan bir görevi duraklatır. Duraklatılmış veya başarısız olan bir görev üzerinde etkisi yoktur.
resume() Duraklatılmış bir görevi devam ettirir. Şu anda çalışan veya başarısız olan bir görev üzerinde etkisi yoktur.
then(onFulFILL, onReduce) Bu nesne bir Promise gibi davranır ve yükleme tamamlandığında anlık görüntü verileriyle çözümlenir.

UploadTask.snapshot

Mevcut görev durumunun anlık görüntüsü.

İmza:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Çalışan bir görevi iptal eder. Tamamlanmış veya başarısız bir görev üzerinde hiçbir etkisi yoktur.

İmza:

cancel(): boolean;

Şunu döndürür:

boolean

İptal işleminin bir etkisi olduysa doğru değerini döndürür.

UploadTask.catch()

then(null, onRejected) çağrısına eşdeğerdir.

İmza:

catch(onRejected: (error: StorageError) => unknown): Promise<unknown>;

Parametreler

Parametre Tür Açıklama
Reddedildi (hata: StorageError) => bilinmiyor

Şunu döndürür:

Söz veriyorum<bilinmiyor>

UploadTask.on()

Bu görevdeki etkinlikleri dinler.

Etkinliklerin üç geri çağırma işlevi vardır (next, error ve complete olarak anılır).

Yalnızca etkinlik geçirilirse geri çağırmaları kaydetmek için kullanılabilecek bir işlev döndürülür. Aksi takdirde, geri çağırmalar etkinlikten sonra iletilir.

Geri çağırmalar üç ayrı bağımsız değişken olarak veya bir nesnenin next, error ve complete özellikleri olarak iletilebilir. En az biri belirtildiği sürece üç geri çağırmatan herhangi biri isteğe bağlıdır. Ayrıca, geri aramalarınızı eklediğinizde bir işlev de geri alırsınız. İlişkili geri çağırmaların kaydını silmek için bu işlevi çağırabilirsiniz.

İmza:

on(event: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, complete?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;

Parametreler

Parametre Tür Açıklama
etkinlik Görev Etkinliği Dinlenecek etkinlik türü.
sonrakiOrGözlemci StorageObserver<UploadTaskSnapshot> | null | ((anlık görüntü: UploadTaskSnapshot) => bilinmiyor) Etkinlik akışındaki her öğe için çağrılan next işlevi veya bu üç özelliğin bir kısmına ya da tümüne sahip bir gözlemci nesnesi (next, error, complete).
hata ((a: StorageError) => bilinmiyor) | boş Etkinlik akışı bir hata nedeniyle sona ererse StorageError ile çağrılan bir işlev.
complete Aboneliği iptal edin | boş

Şunu döndürür:

Aboneliği iptal edin | Abone ol<UploadTaskSnapshot>

Yalnızca etkinlik bağımsız değişkeni geçirilirse geri çağırma eklemek için kullanabileceğiniz bir işlev döndürür (yukarıdaki örneklere bakın). Yalnızca etkinlik bağımsız değişkeni iletilirse geri çağırmaların kaydını iptal etmek için çağırabileceğiniz bir işlev döndürür.

1. örnek

**Geri çağırmaları ayrı olarak veya bir nesne içinde iletin.**

var next = function(snapshot) {};
var error = function(error) {};
var complete = function() {};

// The first example.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    next,
    error,
    complete);

// This is equivalent to the first example.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'next': next,
  'error': error,
  'complete': complete
});

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe(next, error, complete);

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe({
  'next': next,
  'error': error,
  'complete': complete
});

2. örnek

**Geri arama isteğe bağlıdır.**

// Just listening for completion, this is legal.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    null,
    null,
    function() {
      console.log('upload complete!');
    });

// Just listening for progress/state changes, this is legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
});

// This is also legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'complete': function() {
    console.log('upload complete!');
  }
});

3. Örnek

**Geri çağırmaları kaldırmak için döndürülen işlevi kullanın.**

var unsubscribe = uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    function(snapshot) {
      var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
      console.log(percent + "% done");
      // Stop after receiving one update.
      unsubscribe();
    });

// This code is equivalent to the above.
var handle = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
unsubscribe = handle(function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
  // Stop after receiving one update.
  unsubscribe();
});

UploadTask.pause()

Çalışmakta olan bir görevi duraklatır. Duraklatılmış veya başarısız olan bir görev üzerinde etkisi yoktur.

İmza:

pause(): boolean;

Şunu döndürür:

boolean

İşlem gerçekleştiyse doğru, yoksayıldıysa false.

UploadTask.resume()

Duraklatılmış bir görevi devam ettirir. Şu anda çalışan veya başarısız olan bir görev üzerinde etkisi yoktur.

İmza:

resume(): boolean;

Şunu döndürür:

boolean

İşlem gerçekleştiyse doğru, yoksayıldıysa false.

UploadTask.then()

Bu nesne bir Promise gibi davranır ve yükleme tamamlandığında anlık görüntü verileriyle çözümlenir.

İmza:

then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: StorageError) => unknown) | null): Promise<unknown>;

Parametreler

Parametre Tür Açıklama
onFulfill ((anlık görüntü: UploadTaskSnapshot) => bilinmiyor) | boş Sipariş karşılama geri araması. Taahhüt zinciri normal şekilde çalışır.
Reddedildi ((hata: StorageError) => bilinmiyor) | boş Reddetme geri çağırması.

Şunu döndürür:

Söz veriyorum<bilinmiyor>