Bir nesneyi yükleme işlemini temsil eder. Yüklemeyi izlemenizi ve yönetmenizi sağlar.
İmza:
export interface UploadTask
Özellikler
Mülk | Tip | Tanım |
---|---|---|
enstantane fotoğraf | Görev Anlık Görüntüsünü Yükle | Geçerli görev durumunun anlık görüntüsü. |
Yöntemler
Yöntem | Tanım |
---|---|
iptal etmek() | Çalışan bir görevi iptal eder. Tamamlanan veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur. |
yakala(Reddedildi) | then(null, onRejected) işlevini çağırmaya eşdeğerdir. |
on(olay, nextOrObserver, hata, tamamlandı) | Bu görevdeki olayları dinler. Olayların üç geri çağırma işlevi vardır ( next , error complete olarak anılır). Yalnızca olay iletilirse, geri aramaları kaydetmek için kullanılabilecek bir işlev döndürülür. Aksi takdirde geri aramalar olaydan sonra iletilir. Geri çağırmalar üç ayrı bağımsız değişken olarak ya da bir nesnenin next , error ve complete özellikleri olarak iletilebilir. En az biri belirtildiği sürece, üç geri aramadan herhangi biri isteğe bağlıdır. Ayrıca geri aramalarınızı eklediğinizde bir işlev geri alırsınız. İlişkili geri aramaların kaydını silmek için bu işlevi çağırabilirsiniz. |
Duraklat() | Şu anda çalışan bir görevi duraklatır. Duraklatılmış veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur. |
sürdürmek() | Duraklatılmış bir görevi sürdürür. Şu anda çalışan veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur. |
sonra(Doğrulandı, Reddedildi) | Bu nesne bir Promise gibi davranır ve yükleme tamamlandığında anlık görüntü verileriyle çözümlenir. |
UploadTask.snapshot
Geçerli görev durumunun anlık görüntüsü.
İmza:
snapshot: UploadTaskSnapshot;
UploadTask.cancel()
Çalışan bir görevi iptal eder. Tamamlanan veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur.
İmza:
cancel(): boolean;
İadeler:
boolean
İptalin bir etkisi olduysa doğrudur.
UploadTask.catch()
then(null, onRejected)
.
İmza:
catch(onRejected: (error: StorageError) => unknown): Promise<unknown>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Reddedildi | (hata: StorageError ) => bilinmiyor |
İadeler:
Söz<bilinmiyor>
UploadTask.on()
Bu görevdeki olayları dinler.
Olayların üç geri çağırma işlevi vardır ( next
olarak anılır). , error
, Ve complete
).
Yalnızca olay iletilirse, geri aramaları kaydetmek için kullanılabilecek bir işlev döndürülür. Aksi takdirde geri aramalar olaydan sonra iletilir.
Geri aramalar üç ayrı argüman olarak veya bir next
olarak iletilebilir. , error
ve bir nesnenin complete
özellikleri. En az biri belirtildiği sürece, üç geri aramadan herhangi biri isteğe bağlıdır. Ayrıca geri aramalarınızı eklediğinizde bir işlev geri alırsınız. İlişkili geri aramaları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 | Tip | Tanım |
---|---|---|
etkinlik | Görev Olayı | Dinlenecek etkinlik türü. |
nextOrObserver | StorageObserver < Görev Anlık Görüntüsü Yükle > | boş | ((anlık görüntü: UploadTaskSnapshot ) => bilinmiyor) | Olay akışındaki her öğe için çağrılan next işlev veya bu üç özelliğin bazılarına veya tümüne ( next , error , complete ) sahip bir gözlemci nesnesi. |
hata | ((a: Depolama Hatası ) => bilinmiyor) | hükümsüz | Olay akışı bir hata nedeniyle sona ererse StorageError ile çağrılan bir işlev. |
tamamlamak | Abonelikten çık | hükümsüz |
İadeler:
Abonelikten çık | Abone < Görev Anlık Görüntüsü Yükle >
Yalnızca olay bağımsız değişkeni iletilirse, geri arama eklemek için kullanabileceğiniz bir işlevi döndürür (yukarıdaki örneklere bakın). Eğer olay argümanından fazlası iletilirse, geri aramaların kaydını silmek için arayabileceğiniz bir fonksiyon döndürür.
örnek 1
**Geri aramaları ayrı ayrı 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
});
Örnek 2
**Herhangi bir 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!');
}
});
Örnek 3
**Geri aramaları 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()
Şu anda çalışan bir görevi duraklatır. Duraklatılmış veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur.
İmza:
pause(): boolean;
İadeler:
boolean
İşlem etkili olduysa doğru, yoksayıldıysa yanlış.
UploadTask.resume()
Duraklatılmış bir görevi sürdürür. Şu anda çalışan veya başarısız olan bir görev üzerinde hiçbir etkisi yoktur.
İmza:
resume(): boolean;
İadeler:
boolean
İşlem etkili olduysa doğru, yoksayıldıysa yanlış.
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 | Tip | Tanım |
---|---|---|
yerine getirildi | ((anlık görüntü: UploadTaskSnapshot ) => bilinmiyor) | hükümsüz | Yerine getirme geri araması. Söz zincirleme normal şekilde çalışır. |
Reddedildi | ((hata: StorageError ) => bilinmiyor) | hükümsüz | Reddetme geri araması. |
İadeler:
Söz<bilinmiyor>