webext-schema 2.0.3 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/modules/update.js +10 -4
- package/package.json +8 -8
- package/schemas/beta/webext.json +263 -50
- package/schemas/central/webext.json +368 -50
- package/schemas/mail/mailext.json +265 -115
- package/schemas/release/webext.json +210 -49
|
@@ -331,6 +331,22 @@
|
|
|
331
331
|
"$ref": "extensionTypes.RunAt",
|
|
332
332
|
"optional": true,
|
|
333
333
|
"description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
|
|
334
|
+
},
|
|
335
|
+
"cookieStoreId": {
|
|
336
|
+
"choices": [
|
|
337
|
+
{
|
|
338
|
+
"type": "array",
|
|
339
|
+
"minItems": 1,
|
|
340
|
+
"items": {
|
|
341
|
+
"type": "string"
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"type": "string"
|
|
346
|
+
}
|
|
347
|
+
],
|
|
348
|
+
"optional": true,
|
|
349
|
+
"description": "limit the set of matched tabs to those that belong to the given cookie store id"
|
|
334
350
|
}
|
|
335
351
|
}
|
|
336
352
|
},
|
|
@@ -1772,6 +1788,27 @@
|
|
|
1772
1788
|
"description": "The fully-qualified URL to the resource."
|
|
1773
1789
|
}
|
|
1774
1790
|
},
|
|
1791
|
+
{
|
|
1792
|
+
"name": "getFrameId",
|
|
1793
|
+
"type": "function",
|
|
1794
|
+
"allowedContexts": [
|
|
1795
|
+
"content",
|
|
1796
|
+
"devtools"
|
|
1797
|
+
],
|
|
1798
|
+
"description": "Get the frameId of any window global or frame element.",
|
|
1799
|
+
"parameters": [
|
|
1800
|
+
{
|
|
1801
|
+
"type": "any",
|
|
1802
|
+
"name": "target",
|
|
1803
|
+
"description": "A WindowProxy or a Browsing Context container element (IFrame, Frame, Embed, Object) for the target frame."
|
|
1804
|
+
}
|
|
1805
|
+
],
|
|
1806
|
+
"allowCrossOriginArguments": true,
|
|
1807
|
+
"returns": {
|
|
1808
|
+
"type": "number",
|
|
1809
|
+
"description": "The frameId of the target frame, or -1 if it doesn't exist."
|
|
1810
|
+
}
|
|
1811
|
+
},
|
|
1775
1812
|
{
|
|
1776
1813
|
"name": "setUninstallURL",
|
|
1777
1814
|
"type": "function",
|
|
@@ -3915,7 +3952,7 @@
|
|
|
3915
3952
|
"items": {
|
|
3916
3953
|
"$ref": "ThemeIcons"
|
|
3917
3954
|
},
|
|
3918
|
-
"description": "Specifies icons to
|
|
3955
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note: The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
3919
3956
|
},
|
|
3920
3957
|
"default_popup": {
|
|
3921
3958
|
"type": "string",
|
|
@@ -4655,15 +4692,15 @@
|
|
|
4655
4692
|
"properties": {
|
|
4656
4693
|
"browser_style": {
|
|
4657
4694
|
"type": "boolean",
|
|
4658
|
-
"description": "Enable browser styles. See the `MDN documentation <https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles>`__ for more information.",
|
|
4695
|
+
"description": "Enable browser styles in the ``management_url`` page. See the `MDN documentation <https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles>`__ for more information.",
|
|
4659
4696
|
"optional": true,
|
|
4660
4697
|
"default": false
|
|
4661
4698
|
},
|
|
4662
4699
|
"data_format": {
|
|
4663
4700
|
"type": "string",
|
|
4664
4701
|
"optional": true,
|
|
4665
|
-
"default": "
|
|
4666
|
-
"description": "Determines the format of the ``data`` argument in ``onFileUpload``.",
|
|
4702
|
+
"default": "File",
|
|
4703
|
+
"description": "Determines the format of the ``data`` argument in ``onFileUpload``. Support for ArrayBuffer will be removed in Thunderbird 102.",
|
|
4667
4704
|
"enum": [
|
|
4668
4705
|
"ArrayBuffer",
|
|
4669
4706
|
"File"
|
|
@@ -4689,7 +4726,8 @@
|
|
|
4689
4726
|
"service_url": {
|
|
4690
4727
|
"type": "string",
|
|
4691
4728
|
"optional": true,
|
|
4692
|
-
"
|
|
4729
|
+
"deprecated": true,
|
|
4730
|
+
"description": "This property is no longer used. The ``service_url`` property of the :ref:`cloudFile.CloudFileTemplateInfo` object returned by the :ref:`cloudFile.onFileUpload` event can be used to add a ``Learn more about`` link to the footer of the cloud file attachment element."
|
|
4693
4731
|
}
|
|
4694
4732
|
},
|
|
4695
4733
|
"optional": true
|
|
@@ -4710,17 +4748,17 @@
|
|
|
4710
4748
|
{
|
|
4711
4749
|
"name": "onFileUpload",
|
|
4712
4750
|
"type": "function",
|
|
4713
|
-
"description": "Fired when a file should be uploaded to the cloud file provider",
|
|
4751
|
+
"description": "Fired when a file should be uploaded to the cloud file provider.",
|
|
4714
4752
|
"parameters": [
|
|
4715
4753
|
{
|
|
4716
4754
|
"name": "account",
|
|
4717
4755
|
"$ref": "CloudFileAccount",
|
|
4718
|
-
"description": "The
|
|
4756
|
+
"description": "The account used for the file upload."
|
|
4719
4757
|
},
|
|
4720
4758
|
{
|
|
4721
4759
|
"name": "fileInfo",
|
|
4722
4760
|
"$ref": "CloudFile",
|
|
4723
|
-
"description": "The file to upload"
|
|
4761
|
+
"description": "The file to upload."
|
|
4724
4762
|
},
|
|
4725
4763
|
{
|
|
4726
4764
|
"name": "tab",
|
|
@@ -4733,12 +4771,29 @@
|
|
|
4733
4771
|
"properties": {
|
|
4734
4772
|
"aborted": {
|
|
4735
4773
|
"type": "boolean",
|
|
4736
|
-
"description": "Set this to true if the file upload was aborted",
|
|
4774
|
+
"description": "Set this to true if the file upload was aborted.",
|
|
4775
|
+
"optional": true
|
|
4776
|
+
},
|
|
4777
|
+
"error": {
|
|
4778
|
+
"choices": [
|
|
4779
|
+
{
|
|
4780
|
+
"type": "boolean"
|
|
4781
|
+
},
|
|
4782
|
+
{
|
|
4783
|
+
"type": "string"
|
|
4784
|
+
}
|
|
4785
|
+
],
|
|
4786
|
+
"description": "Report an error to the user. Set this to true for showing a generic error message, or set a specific error message.",
|
|
4737
4787
|
"optional": true
|
|
4738
4788
|
},
|
|
4739
4789
|
"url": {
|
|
4740
4790
|
"type": "string",
|
|
4741
|
-
"description": "The URL where the uploaded file can be accessed",
|
|
4791
|
+
"description": "The URL where the uploaded file can be accessed.",
|
|
4792
|
+
"optional": true
|
|
4793
|
+
},
|
|
4794
|
+
"templateInfo": {
|
|
4795
|
+
"$ref": "CloudFileTemplateInfo",
|
|
4796
|
+
"description": "Defines information to be used in the cloud file entry added to the message.",
|
|
4742
4797
|
"optional": true
|
|
4743
4798
|
}
|
|
4744
4799
|
}
|
|
@@ -4751,13 +4806,13 @@
|
|
|
4751
4806
|
{
|
|
4752
4807
|
"name": "account",
|
|
4753
4808
|
"$ref": "CloudFileAccount",
|
|
4754
|
-
"description": "The
|
|
4809
|
+
"description": "The account used for the file upload."
|
|
4755
4810
|
},
|
|
4756
4811
|
{
|
|
4757
4812
|
"type": "integer",
|
|
4758
4813
|
"name": "fileId",
|
|
4759
4814
|
"minimum": 1,
|
|
4760
|
-
"description": "An identifier for this file"
|
|
4815
|
+
"description": "An identifier for this file."
|
|
4761
4816
|
},
|
|
4762
4817
|
{
|
|
4763
4818
|
"name": "tab",
|
|
@@ -4766,21 +4821,71 @@
|
|
|
4766
4821
|
}
|
|
4767
4822
|
]
|
|
4768
4823
|
},
|
|
4824
|
+
{
|
|
4825
|
+
"name": "onFileRename",
|
|
4826
|
+
"type": "function",
|
|
4827
|
+
"description": "Fired when a previously uploaded file should be renamed.",
|
|
4828
|
+
"parameters": [
|
|
4829
|
+
{
|
|
4830
|
+
"name": "account",
|
|
4831
|
+
"$ref": "CloudFileAccount",
|
|
4832
|
+
"description": "The account used for the file upload."
|
|
4833
|
+
},
|
|
4834
|
+
{
|
|
4835
|
+
"type": "integer",
|
|
4836
|
+
"name": "fileId",
|
|
4837
|
+
"minimum": 1,
|
|
4838
|
+
"description": "An identifier for the file which should be renamed."
|
|
4839
|
+
},
|
|
4840
|
+
{
|
|
4841
|
+
"type": "string",
|
|
4842
|
+
"name": "newName",
|
|
4843
|
+
"description": "The new name of the file."
|
|
4844
|
+
},
|
|
4845
|
+
{
|
|
4846
|
+
"name": "tab",
|
|
4847
|
+
"$ref": "tabs.Tab",
|
|
4848
|
+
"description": "The tab where the rename was initiated. Currently only available for the message composer."
|
|
4849
|
+
}
|
|
4850
|
+
],
|
|
4851
|
+
"returns": {
|
|
4852
|
+
"type": "object",
|
|
4853
|
+
"properties": {
|
|
4854
|
+
"error": {
|
|
4855
|
+
"choices": [
|
|
4856
|
+
{
|
|
4857
|
+
"type": "boolean"
|
|
4858
|
+
},
|
|
4859
|
+
{
|
|
4860
|
+
"type": "string"
|
|
4861
|
+
}
|
|
4862
|
+
],
|
|
4863
|
+
"description": "Report an error to the user. Set this to true for showing a generic error message, or set a specific error message.",
|
|
4864
|
+
"optional": true
|
|
4865
|
+
},
|
|
4866
|
+
"url": {
|
|
4867
|
+
"type": "string",
|
|
4868
|
+
"description": "The URL where the renamed file can be accessed.",
|
|
4869
|
+
"optional": true
|
|
4870
|
+
}
|
|
4871
|
+
}
|
|
4872
|
+
}
|
|
4873
|
+
},
|
|
4769
4874
|
{
|
|
4770
4875
|
"name": "onFileDeleted",
|
|
4771
4876
|
"type": "function",
|
|
4772
|
-
"description": "Fired when a
|
|
4877
|
+
"description": "Fired when a previously uploaded file should be deleted.",
|
|
4773
4878
|
"parameters": [
|
|
4774
4879
|
{
|
|
4775
4880
|
"name": "account",
|
|
4776
4881
|
"$ref": "CloudFileAccount",
|
|
4777
|
-
"description": "The
|
|
4882
|
+
"description": "The account used for the file upload."
|
|
4778
4883
|
},
|
|
4779
4884
|
{
|
|
4780
4885
|
"type": "integer",
|
|
4781
4886
|
"name": "fileId",
|
|
4782
4887
|
"minimum": 1,
|
|
4783
|
-
"description": "An identifier for this file"
|
|
4888
|
+
"description": "An identifier for this file."
|
|
4784
4889
|
},
|
|
4785
4890
|
{
|
|
4786
4891
|
"name": "tab",
|
|
@@ -4792,24 +4897,24 @@
|
|
|
4792
4897
|
{
|
|
4793
4898
|
"name": "onAccountAdded",
|
|
4794
4899
|
"type": "function",
|
|
4795
|
-
"description": "Fired when a cloud file account of this add-on was created",
|
|
4900
|
+
"description": "Fired when a cloud file account of this add-on was created.",
|
|
4796
4901
|
"parameters": [
|
|
4797
4902
|
{
|
|
4798
4903
|
"name": "account",
|
|
4799
4904
|
"$ref": "CloudFileAccount",
|
|
4800
|
-
"description": "The created account"
|
|
4905
|
+
"description": "The created account."
|
|
4801
4906
|
}
|
|
4802
4907
|
]
|
|
4803
4908
|
},
|
|
4804
4909
|
{
|
|
4805
4910
|
"name": "onAccountDeleted",
|
|
4806
4911
|
"type": "function",
|
|
4807
|
-
"description": "Fired when a cloud file account of this add-on was deleted",
|
|
4912
|
+
"description": "Fired when a cloud file account of this add-on was deleted.",
|
|
4808
4913
|
"parameters": [
|
|
4809
4914
|
{
|
|
4810
4915
|
"name": "accountId",
|
|
4811
4916
|
"type": "string",
|
|
4812
|
-
"description": "The id of the removed account"
|
|
4917
|
+
"description": "The id of the removed account."
|
|
4813
4918
|
}
|
|
4814
4919
|
]
|
|
4815
4920
|
}
|
|
@@ -4818,11 +4923,11 @@
|
|
|
4818
4923
|
{
|
|
4819
4924
|
"id": "CloudFileAccount",
|
|
4820
4925
|
"type": "object",
|
|
4821
|
-
"description": "Information about a cloud file account",
|
|
4926
|
+
"description": "Information about a cloud file account.",
|
|
4822
4927
|
"properties": {
|
|
4823
4928
|
"id": {
|
|
4824
4929
|
"type": "string",
|
|
4825
|
-
"description": "Unique identifier of the account"
|
|
4930
|
+
"description": "Unique identifier of the account."
|
|
4826
4931
|
},
|
|
4827
4932
|
"configured": {
|
|
4828
4933
|
"type": "boolean",
|
|
@@ -4857,19 +4962,68 @@
|
|
|
4857
4962
|
}
|
|
4858
4963
|
}
|
|
4859
4964
|
},
|
|
4965
|
+
{
|
|
4966
|
+
"id": "CloudFileTemplateInfo",
|
|
4967
|
+
"type": "object",
|
|
4968
|
+
"description": "Defines information to be used in the cloud file entry added to the message.",
|
|
4969
|
+
"properties": {
|
|
4970
|
+
"service_icon": {
|
|
4971
|
+
"type": "string",
|
|
4972
|
+
"optional": true,
|
|
4973
|
+
"description": "A URL pointing to an icon to represent the used cloud file service. Defaults to the icon of the provider add-on."
|
|
4974
|
+
},
|
|
4975
|
+
"service_name": {
|
|
4976
|
+
"type": "string",
|
|
4977
|
+
"optional": true,
|
|
4978
|
+
"description": "A name to represent the used cloud file service. Defaults to the associated cloud file account name."
|
|
4979
|
+
},
|
|
4980
|
+
"service_url": {
|
|
4981
|
+
"type": "string",
|
|
4982
|
+
"optional": true,
|
|
4983
|
+
"description": "A URL pointing to a web page of the used cloud file service. Will be used in a ``Learn more about`` link in the footer of the cloud file attachment element."
|
|
4984
|
+
},
|
|
4985
|
+
"download_password_protected": {
|
|
4986
|
+
"type": "boolean",
|
|
4987
|
+
"optional": true,
|
|
4988
|
+
"description": "If set to true, the cloud file entry for this upload will include a hint, that the download link is password protected."
|
|
4989
|
+
},
|
|
4990
|
+
"download_limit": {
|
|
4991
|
+
"type": "integer",
|
|
4992
|
+
"optional": true,
|
|
4993
|
+
"description": "If set, the cloud file entry for this upload will include a hint, that the file has a download limit."
|
|
4994
|
+
},
|
|
4995
|
+
"download_expiry_date": {
|
|
4996
|
+
"type": "object",
|
|
4997
|
+
"optional": true,
|
|
4998
|
+
"description": "If set, the cloud file entry for this upload will include a hint, that the link will only be available for a limited time.",
|
|
4999
|
+
"properties": {
|
|
5000
|
+
"timestamp": {
|
|
5001
|
+
"type": "integer",
|
|
5002
|
+
"description": "The expiry date of the link as the number of milliseconds since the UNIX epoch."
|
|
5003
|
+
},
|
|
5004
|
+
"format": {
|
|
5005
|
+
"optional": true,
|
|
5006
|
+
"description": "A format options object as used by `Intl.DateTimeFormat <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat>`__. Defaults to: <literalinclude>includes/cloudFile/defaultDateFormat.js<lang>JavaScript</lang></literalinclude>",
|
|
5007
|
+
"type": "object",
|
|
5008
|
+
"additionalProperties": true
|
|
5009
|
+
}
|
|
5010
|
+
}
|
|
5011
|
+
}
|
|
5012
|
+
}
|
|
5013
|
+
},
|
|
4860
5014
|
{
|
|
4861
5015
|
"id": "CloudFile",
|
|
4862
5016
|
"type": "object",
|
|
4863
|
-
"description": "Information about a cloud file",
|
|
5017
|
+
"description": "Information about a cloud file.",
|
|
4864
5018
|
"properties": {
|
|
4865
5019
|
"id": {
|
|
4866
5020
|
"type": "integer",
|
|
4867
5021
|
"minimum": 1,
|
|
4868
|
-
"description": "An identifier for this file"
|
|
5022
|
+
"description": "An identifier for this file."
|
|
4869
5023
|
},
|
|
4870
5024
|
"name": {
|
|
4871
5025
|
"type": "string",
|
|
4872
|
-
"description": "Filename of the file to be transferred"
|
|
5026
|
+
"description": "Filename of the file to be transferred."
|
|
4873
5027
|
},
|
|
4874
5028
|
"data": {
|
|
4875
5029
|
"choices": [
|
|
@@ -4877,13 +5031,13 @@
|
|
|
4877
5031
|
"type": "object",
|
|
4878
5032
|
"isInstanceOf": "ArrayBuffer",
|
|
4879
5033
|
"additionalProperties": true,
|
|
4880
|
-
"description": "Contents of the file to be transferred"
|
|
5034
|
+
"description": "Contents of the file to be transferred."
|
|
4881
5035
|
},
|
|
4882
5036
|
{
|
|
4883
5037
|
"type": "object",
|
|
4884
5038
|
"isInstanceOf": "File",
|
|
4885
5039
|
"additionalProperties": true,
|
|
4886
|
-
"description": "Contents of the file to be transferred"
|
|
5040
|
+
"description": "Contents of the file to be transferred."
|
|
4887
5041
|
}
|
|
4888
5042
|
]
|
|
4889
5043
|
}
|
|
@@ -4894,7 +5048,7 @@
|
|
|
4894
5048
|
{
|
|
4895
5049
|
"name": "getAccount",
|
|
4896
5050
|
"type": "function",
|
|
4897
|
-
"description": "Retrieve information about a single cloud file account",
|
|
5051
|
+
"description": "Retrieve information about a single cloud file account.",
|
|
4898
5052
|
"allowedContexts": [
|
|
4899
5053
|
"content"
|
|
4900
5054
|
],
|
|
@@ -4903,7 +5057,7 @@
|
|
|
4903
5057
|
{
|
|
4904
5058
|
"name": "accountId",
|
|
4905
5059
|
"type": "string",
|
|
4906
|
-
"description": "Unique identifier of the account"
|
|
5060
|
+
"description": "Unique identifier of the account."
|
|
4907
5061
|
},
|
|
4908
5062
|
{
|
|
4909
5063
|
"type": "function",
|
|
@@ -4920,7 +5074,7 @@
|
|
|
4920
5074
|
{
|
|
4921
5075
|
"name": "getAllAccounts",
|
|
4922
5076
|
"type": "function",
|
|
4923
|
-
"description": "Retrieve all cloud file accounts for the current add-on",
|
|
5077
|
+
"description": "Retrieve all cloud file accounts for the current add-on.",
|
|
4924
5078
|
"allowedContexts": [
|
|
4925
5079
|
"content"
|
|
4926
5080
|
],
|
|
@@ -4944,7 +5098,7 @@
|
|
|
4944
5098
|
{
|
|
4945
5099
|
"name": "updateAccount",
|
|
4946
5100
|
"type": "function",
|
|
4947
|
-
"description": "Update a cloud file account",
|
|
5101
|
+
"description": "Update a cloud file account.",
|
|
4948
5102
|
"allowedContexts": [
|
|
4949
5103
|
"content"
|
|
4950
5104
|
],
|
|
@@ -4953,7 +5107,7 @@
|
|
|
4953
5107
|
{
|
|
4954
5108
|
"name": "accountId",
|
|
4955
5109
|
"type": "string",
|
|
4956
|
-
"description": "Unique identifier of the account"
|
|
5110
|
+
"description": "Unique identifier of the account."
|
|
4957
5111
|
},
|
|
4958
5112
|
{
|
|
4959
5113
|
"name": "updateProperties",
|
|
@@ -5093,7 +5247,7 @@
|
|
|
5093
5247
|
},
|
|
5094
5248
|
"from": {
|
|
5095
5249
|
"$ref": "ComposeRecipient",
|
|
5096
|
-
"description": "*Caution*: Setting a value for
|
|
5250
|
+
"description": "*Caution*: Setting a value for ``from`` does not change the used identity, it overrides the FROM header. Many email servers do not accept emails where the FROM header does not match the sender identity. Must be set to exactly one valid email address.",
|
|
5097
5251
|
"optional": true
|
|
5098
5252
|
},
|
|
5099
5253
|
"to": {
|
|
@@ -5155,38 +5309,55 @@
|
|
|
5155
5309
|
},
|
|
5156
5310
|
"body": {
|
|
5157
5311
|
"type": "string",
|
|
5312
|
+
"description": "The HTML content of the message. Ignored by ``setComposeDetails``, if used on a plain text composer. If only ``body`` is specified when used with ``beginNew``, ``beginReply`` and similar functions, an HTML message will be created. The recommended usage is to always specify both (``body`` and ``plainTextBody``) and use ``isPlainText`` to select the compose format, or use the users default compose format.",
|
|
5158
5313
|
"optional": true
|
|
5159
5314
|
},
|
|
5160
5315
|
"plainTextBody": {
|
|
5161
5316
|
"type": "string",
|
|
5317
|
+
"description": "The plain text content of the message. Ignored by ``setComposeDetails``, if used on an HTML composer. If only ``plainTextBody`` is specified when used with ``beginNew``, ``beginReply`` and similar functions, a plain text message will be created. The recommended usage is to always specify both (``body`` and ``plainTextBody``) and use ``isPlainText`` to select the compose format, or use the users default compose format.",
|
|
5162
5318
|
"optional": true
|
|
5163
5319
|
},
|
|
5164
5320
|
"isPlainText": {
|
|
5165
5321
|
"type": "boolean",
|
|
5322
|
+
"description": "Wether the message is an HTML message or a plain text message. Can be used to specify the message format in ``beginNew``, ``beginReply`` and similar functions. It is however not possible to change the compose format with ``setComposeDetails``. Note: Using ``isPlainText`` together with a single but conflicting body type (e.g.: ``isPlainText`` = ``true`` and ``body`` is set but not ``plainTextBody``) will cause an exception. ",
|
|
5166
5323
|
"optional": true
|
|
5167
5324
|
},
|
|
5168
5325
|
"attachments": {
|
|
5169
5326
|
"type": "array",
|
|
5170
5327
|
"items": {
|
|
5171
|
-
"
|
|
5172
|
-
|
|
5173
|
-
|
|
5174
|
-
"type": "string",
|
|
5175
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5176
|
-
"optional": true
|
|
5328
|
+
"choices": [
|
|
5329
|
+
{
|
|
5330
|
+
"$ref": "FileAttachment"
|
|
5177
5331
|
},
|
|
5178
|
-
|
|
5179
|
-
"
|
|
5180
|
-
"isInstanceOf": "File",
|
|
5181
|
-
"additionalProperties": true
|
|
5332
|
+
{
|
|
5333
|
+
"$ref": "ComposeAttachment"
|
|
5182
5334
|
}
|
|
5183
|
-
|
|
5335
|
+
]
|
|
5184
5336
|
},
|
|
5185
5337
|
"description": "Attachments to add to the message. Only used in the begin* functions.",
|
|
5186
5338
|
"optional": true
|
|
5187
5339
|
}
|
|
5188
5340
|
}
|
|
5189
5341
|
},
|
|
5342
|
+
{
|
|
5343
|
+
"id": "FileAttachment",
|
|
5344
|
+
"type": "object",
|
|
5345
|
+
"description": "Object used to add, update or rename an attachment in a message being composed.",
|
|
5346
|
+
"properties": {
|
|
5347
|
+
"file": {
|
|
5348
|
+
"type": "object",
|
|
5349
|
+
"isInstanceOf": "File",
|
|
5350
|
+
"additionalProperties": true,
|
|
5351
|
+
"description": "The new content for the attachment.",
|
|
5352
|
+
"optional": true
|
|
5353
|
+
},
|
|
5354
|
+
"name": {
|
|
5355
|
+
"type": "string",
|
|
5356
|
+
"description": "The new name for the attachment, as displayed to the user. If not specified, the name of the provided ``file`` object is used.",
|
|
5357
|
+
"optional": true
|
|
5358
|
+
}
|
|
5359
|
+
}
|
|
5360
|
+
},
|
|
5190
5361
|
{
|
|
5191
5362
|
"id": "ComposeAttachment",
|
|
5192
5363
|
"type": "object",
|
|
@@ -5198,22 +5369,15 @@
|
|
|
5198
5369
|
},
|
|
5199
5370
|
"name": {
|
|
5200
5371
|
"type": "string",
|
|
5201
|
-
"
|
|
5372
|
+
"optional": true,
|
|
5373
|
+
"description": "The name of this attachment, as displayed to the user."
|
|
5202
5374
|
},
|
|
5203
5375
|
"size": {
|
|
5204
5376
|
"type": "integer",
|
|
5205
|
-
"
|
|
5206
|
-
|
|
5207
|
-
},
|
|
5208
|
-
"functions": [
|
|
5209
|
-
{
|
|
5210
|
-
"name": "getFile",
|
|
5211
|
-
"type": "function",
|
|
5212
|
-
"description": "Retrieves the contents of the attachment as a DOM ``File`` object.",
|
|
5213
|
-
"async": true,
|
|
5214
|
-
"parameters": []
|
|
5377
|
+
"optional": true,
|
|
5378
|
+
"description": "The size in bytes of this attachment. Read-only."
|
|
5215
5379
|
}
|
|
5216
|
-
|
|
5380
|
+
}
|
|
5217
5381
|
}
|
|
5218
5382
|
],
|
|
5219
5383
|
"events": [
|
|
@@ -5498,17 +5662,35 @@
|
|
|
5498
5662
|
"optional": true,
|
|
5499
5663
|
"parameters": [
|
|
5500
5664
|
{
|
|
5501
|
-
"
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
|
|
5505
|
-
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
|
|
5509
|
-
|
|
5510
|
-
|
|
5511
|
-
|
|
5665
|
+
"type": "array",
|
|
5666
|
+
"items": {
|
|
5667
|
+
"$ref": "ComposeAttachment"
|
|
5668
|
+
}
|
|
5669
|
+
}
|
|
5670
|
+
]
|
|
5671
|
+
}
|
|
5672
|
+
]
|
|
5673
|
+
},
|
|
5674
|
+
{
|
|
5675
|
+
"name": "getAttachmentFile",
|
|
5676
|
+
"type": "function",
|
|
5677
|
+
"description": "Gets the content of a :ref:`compose.ComposeAttachment` as a DOM <code>File</code> object.",
|
|
5678
|
+
"async": "callback",
|
|
5679
|
+
"parameters": [
|
|
5680
|
+
{
|
|
5681
|
+
"name": "id",
|
|
5682
|
+
"type": "integer",
|
|
5683
|
+
"description": "The unique identifier for the attachment."
|
|
5684
|
+
},
|
|
5685
|
+
{
|
|
5686
|
+
"type": "function",
|
|
5687
|
+
"name": "callback",
|
|
5688
|
+
"optional": true,
|
|
5689
|
+
"parameters": [
|
|
5690
|
+
{
|
|
5691
|
+
"type": "object",
|
|
5692
|
+
"isInstanceOf": "File",
|
|
5693
|
+
"additionalProperties": true
|
|
5512
5694
|
}
|
|
5513
5695
|
]
|
|
5514
5696
|
}
|
|
@@ -5528,20 +5710,15 @@
|
|
|
5528
5710
|
"type": "integer"
|
|
5529
5711
|
},
|
|
5530
5712
|
{
|
|
5531
|
-
"name": "
|
|
5532
|
-
"
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
"type": "string",
|
|
5536
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5537
|
-
"optional": true
|
|
5713
|
+
"name": "attachment",
|
|
5714
|
+
"choices": [
|
|
5715
|
+
{
|
|
5716
|
+
"$ref": "FileAttachment"
|
|
5538
5717
|
},
|
|
5539
|
-
|
|
5540
|
-
"
|
|
5541
|
-
"isInstanceOf": "File",
|
|
5542
|
-
"additionalProperties": true
|
|
5718
|
+
{
|
|
5719
|
+
"$ref": "ComposeAttachment"
|
|
5543
5720
|
}
|
|
5544
|
-
|
|
5721
|
+
]
|
|
5545
5722
|
},
|
|
5546
5723
|
{
|
|
5547
5724
|
"type": "function",
|
|
@@ -5549,14 +5726,7 @@
|
|
|
5549
5726
|
"optional": true,
|
|
5550
5727
|
"parameters": [
|
|
5551
5728
|
{
|
|
5552
|
-
"
|
|
5553
|
-
{
|
|
5554
|
-
"$ref": "ComposeAttachment"
|
|
5555
|
-
},
|
|
5556
|
-
{
|
|
5557
|
-
"type": "any"
|
|
5558
|
-
}
|
|
5559
|
-
]
|
|
5729
|
+
"$ref": "ComposeAttachment"
|
|
5560
5730
|
}
|
|
5561
5731
|
]
|
|
5562
5732
|
}
|
|
@@ -5565,7 +5735,7 @@
|
|
|
5565
5735
|
{
|
|
5566
5736
|
"name": "updateAttachment",
|
|
5567
5737
|
"type": "function",
|
|
5568
|
-
"description": "
|
|
5738
|
+
"description": "Updates the name and/or the content of an attachment in the message being composed in the specified tab. If the specified attachment is a cloud file attachment and the associated provider failed to update the attachment, the function will throw an ``ExtensionError``.",
|
|
5569
5739
|
"permissions": [
|
|
5570
5740
|
"compose"
|
|
5571
5741
|
],
|
|
@@ -5580,21 +5750,8 @@
|
|
|
5580
5750
|
"type": "integer"
|
|
5581
5751
|
},
|
|
5582
5752
|
{
|
|
5583
|
-
"name": "
|
|
5584
|
-
"
|
|
5585
|
-
"properties": {
|
|
5586
|
-
"name": {
|
|
5587
|
-
"type": "string",
|
|
5588
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5589
|
-
"optional": true
|
|
5590
|
-
},
|
|
5591
|
-
"file": {
|
|
5592
|
-
"type": "object",
|
|
5593
|
-
"isInstanceOf": "File",
|
|
5594
|
-
"additionalProperties": true,
|
|
5595
|
-
"optional": true
|
|
5596
|
-
}
|
|
5597
|
-
}
|
|
5753
|
+
"name": "attachment",
|
|
5754
|
+
"$ref": "FileAttachment"
|
|
5598
5755
|
},
|
|
5599
5756
|
{
|
|
5600
5757
|
"type": "function",
|
|
@@ -5602,14 +5759,7 @@
|
|
|
5602
5759
|
"optional": true,
|
|
5603
5760
|
"parameters": [
|
|
5604
5761
|
{
|
|
5605
|
-
"
|
|
5606
|
-
{
|
|
5607
|
-
"$ref": "ComposeAttachment"
|
|
5608
|
-
},
|
|
5609
|
-
{
|
|
5610
|
-
"type": "any"
|
|
5611
|
-
}
|
|
5612
|
-
]
|
|
5762
|
+
"$ref": "ComposeAttachment"
|
|
5613
5763
|
}
|
|
5614
5764
|
]
|
|
5615
5765
|
}
|
|
@@ -5739,7 +5889,7 @@
|
|
|
5739
5889
|
"items": {
|
|
5740
5890
|
"$ref": "ThemeIcons"
|
|
5741
5891
|
},
|
|
5742
|
-
"description": "Specifies icons to
|
|
5892
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note: The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
5743
5893
|
},
|
|
5744
5894
|
"default_popup": {
|
|
5745
5895
|
"type": "string",
|
|
@@ -8446,7 +8596,7 @@
|
|
|
8446
8596
|
"items": {
|
|
8447
8597
|
"$ref": "ThemeIcons"
|
|
8448
8598
|
},
|
|
8449
|
-
"description": "Specifies icons to
|
|
8599
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note: The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
8450
8600
|
},
|
|
8451
8601
|
"default_popup": {
|
|
8452
8602
|
"type": "string",
|
|
@@ -9211,7 +9361,7 @@
|
|
|
9211
9361
|
}
|
|
9212
9362
|
},
|
|
9213
9363
|
{
|
|
9214
|
-
"id": "
|
|
9364
|
+
"id": "MessageAttachment",
|
|
9215
9365
|
"type": "object",
|
|
9216
9366
|
"description": "Represents an attachment in a message.",
|
|
9217
9367
|
"properties": {
|
|
@@ -9451,7 +9601,7 @@
|
|
|
9451
9601
|
{
|
|
9452
9602
|
"type": "array",
|
|
9453
9603
|
"items": {
|
|
9454
|
-
"$ref": "
|
|
9604
|
+
"$ref": "MessageAttachment"
|
|
9455
9605
|
}
|
|
9456
9606
|
}
|
|
9457
9607
|
]
|
|
@@ -9461,7 +9611,7 @@
|
|
|
9461
9611
|
{
|
|
9462
9612
|
"name": "getAttachmentFile",
|
|
9463
9613
|
"type": "function",
|
|
9464
|
-
"description": "Gets the content of
|
|
9614
|
+
"description": "Gets the content of a :ref:`messages.MessageAttachment` as a DOM <code>File</code> object.",
|
|
9465
9615
|
"async": "callback",
|
|
9466
9616
|
"parameters": [
|
|
9467
9617
|
{
|