gecko-dev/content/base/public/nsIDOMFile.idl

87 lines
2.7 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "domstubs.idl"
%{C++
#include "jsapi.h"
namespace mozilla {
namespace dom {
namespace indexedDB {
class FileInfo;
class FileManager;
}
}
}
%}
[ptr] native FileInfo(mozilla::dom::indexedDB::FileInfo);
[ptr] native FileManager(mozilla::dom::indexedDB::FileManager);
interface nsIDOMFileError;
interface nsIInputStream;
interface nsIURI;
interface nsIPrincipal;
interface nsIDOMBlob;
[scriptable, builtinclass, uuid(f62c6887-e3bc-495a-802c-287e12e969a0)]
interface nsIDOMBlob : nsISupports
{
readonly attribute unsigned long long size;
readonly attribute DOMString type;
[noscript] readonly attribute nsIInputStream internalStream;
// The caller is responsible for releasing the internalUrl from the
// blob: protocol handler
[noscript] DOMString getInternalUrl(in nsIPrincipal principal);
[optional_argc] nsIDOMBlob slice([optional] in long long start,
[optional] in long long end,
[optional] in DOMString contentType);
// Get internal id of stored file. Returns -1 if it is not a stored file.
// Intended only for testing. It can be called on any thread.
[notxpcom] long long getFileId();
// Called when the blob was successfully stored in a database or when
// the blob is initialized from a database. It can be called on any thread.
[notxpcom] void addFileInfo(in FileInfo aFileInfo);
// Called before the blob is stored in a database to decide if it can be
// shared or needs to be copied. It can be called on any thread.
[notxpcom] FileInfo getFileInfo(in FileManager aFileManager);
};
[scriptable, builtinclass, uuid(eee028d1-8ce9-4c6c-b9ce-d89b656e1e17)]
interface nsIDOMFile : nsIDOMBlob
{
readonly attribute DOMString name;
[implicit_jscontext]
readonly attribute jsval lastModifiedDate;
readonly attribute DOMString mozFullPath;
// This performs no security checks!
[noscript] readonly attribute DOMString mozFullPathInternal;
};
[scriptable, builtinclass, uuid(57195950-edd9-496b-9b45-e4893a9ffca9)]
interface nsIDOMMozBlobBuilder : nsISupports
{
nsIDOMBlob getBlob([optional] in DOMString contentType);
nsIDOMFile getFile(in DOMString name, [optional] in DOMString contentType);
[implicit_jscontext] void append(in jsval data,
[optional] in DOMString endings);
};
dictionary BlobPropertyBag
{
DOMString type;
DOMString endings = "transparent";
};