Generated Flare Swift DocC

flare/data/documentation/flare/caching.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Caching products can improve the performance and user experience of your app by reducing the need to fetch product information from the App Store. In this guide, we’ll explore how to cache products efficiently in your app."}]},{"anchor":"Implementing-Product-Caching","level":2,"type":"heading","text":"Implementing Product Caching"},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, Flare uses cached data if available; otherwise, it fetches the products. If you want to change this behavior, you need to configure Flare with a custom caching policy. For this, Flare provides two options "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can override the default behaviour passing a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" with a configuration."}]},{"type":"codeListing","syntax":"swift","code":["Flare.default.configure(with: .init(Configuration(username: \"username\", fetchCachePolicy: .fetch)))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This configuration tells Flare to always fetch the latest data, ignoring any cached data. You can adjust this behavior as needed for your app."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/caching"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/caching","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Learn how to cache products."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Caching Products","role":"article","modules":[{"name":"Flare"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/FetchCachePolicy/cachedOrFetch":{"role":"symbol","title":"FetchCachePolicy.cachedOrFetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"cachedOrFetch"}],"abstract":[{"type":"text","text":"Use the cached data if available; otherwise, fetch the data."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/cachedorfetch"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/documentation/Flare/FetchCachePolicy/fetch":{"role":"symbol","title":"FetchCachePolicy.fetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"fetch"}],"abstract":[{"type":"text","text":"Fetch the current data without using the cache."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/fetch"}}}

flare/data/documentation/flare/configuration.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/configuration"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Flare\/s8SendableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Configuration","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Flare\/documentation\/Flare\/Configuration\/init(applicationUsername:fetchCachePolicy:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","doc:\/\/Flare\/documentation\/Flare\/Configuration\/fetchCachePolicy"]}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"title":"Configuration","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:5Flare13ConfigurationV","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Configuration"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/Configuration":{"role":"symbol","title":"Configuration","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Configuration"}],"url":"\/documentation\/flare\/configuration"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Flare\/s8SendableP"},"doc://Flare/documentation/Flare/Configuration/applicationUsername":{"role":"symbol","title":"applicationUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/applicationusername"},"doc://Flare/documentation/Flare/Configuration/fetchCachePolicy":{"role":"symbol","title":"fetchCachePolicy","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"fetchCachePolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FetchCachePolicy","preciseIdentifier":"s:5Flare16FetchCachePolicyO"}],"abstract":[{"type":"text","text":"The cache policy for fetching products."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/fetchCachePolicy","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/fetchcachepolicy"},"doc://Flare/documentation/Flare/Configuration/init(applicationUsername:fetchCachePolicy:)":{"role":"symbol","title":"init(applicationUsername:fetchCachePolicy:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fetchCachePolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FetchCachePolicy","preciseIdentifier":"s:5Flare16FetchCachePolicyO"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates a "},{"type":"codeVoice","code":"Configuration"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/init(applicationUsername:fetchCachePolicy:)","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/init(applicationusername:fetchcachepolicy:)"}}}
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/configuration"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Flare\/s8SendableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Configuration","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Flare\/documentation\/Flare\/Configuration\/init(applicationUsername:fetchCachePolicy:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","doc:\/\/Flare\/documentation\/Flare\/Configuration\/fetchCachePolicy"]}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"title":"Configuration","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:5Flare13ConfigurationV","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Configuration"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Flare\/s8SendableP"},"doc://Flare/documentation/Flare/Configuration":{"role":"symbol","title":"Configuration","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Configuration"}],"url":"\/documentation\/flare\/configuration"},"doc://Flare/documentation/Flare/Configuration/init(applicationUsername:fetchCachePolicy:)":{"role":"symbol","title":"init(applicationUsername:fetchCachePolicy:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fetchCachePolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FetchCachePolicy","preciseIdentifier":"s:5Flare16FetchCachePolicyO"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates a "},{"type":"codeVoice","code":"Configuration"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/init(applicationUsername:fetchCachePolicy:)","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/init(applicationusername:fetchcachepolicy:)"},"doc://Flare/documentation/Flare/Configuration/applicationUsername":{"role":"symbol","title":"applicationUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/applicationusername"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/documentation/Flare/Configuration/fetchCachePolicy":{"role":"symbol","title":"fetchCachePolicy","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"fetchCachePolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FetchCachePolicy","preciseIdentifier":"s:5Flare16FetchCachePolicyO"}],"abstract":[{"type":"text","text":"The cache policy for fetching products."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/fetchCachePolicy","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/fetchcachepolicy"}}}

flare/data/documentation/flare/configuration/applicationusername.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You must set "},{"type":"codeVoice","code":"applicationUsername"},{"type":"text","text":" to be the same as the one used to generate the signature."}]}],"type":"aside","name":"Important"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/configuration\/applicationusername"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"applicationUsername","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Flare13ConfigurationV19applicationUsernameSSvp","modules":[{"name":"Flare"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare","doc:\/\/Flare\/documentation\/Flare\/Configuration"]]},"references":{"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/documentation/Flare/Configuration":{"role":"symbol","title":"Configuration","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Configuration"}],"url":"\/documentation\/flare\/configuration"},"doc://Flare/documentation/Flare/Configuration/applicationUsername":{"role":"symbol","title":"applicationUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/applicationusername"}}}
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You must set "},{"type":"codeVoice","code":"applicationUsername"},{"type":"text","text":" to be the same as the one used to generate the signature."}]}],"type":"aside","name":"Important"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/configuration\/applicationusername"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"applicationUsername","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Flare13ConfigurationV19applicationUsernameSSvp","modules":[{"name":"Flare"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare","doc:\/\/Flare\/documentation\/Flare\/Configuration"]]},"references":{"doc://Flare/documentation/Flare/Configuration/applicationUsername":{"role":"symbol","title":"applicationUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"applicationUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"A string that associates the transaction with a user account on your service."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration\/applicationUsername","kind":"symbol","type":"topic","url":"\/documentation\/flare\/configuration\/applicationusername"},"doc://Flare/documentation/Flare/Configuration":{"role":"symbol","title":"Configuration","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Configuration"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Configuration","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Configuration"}],"url":"\/documentation\/flare\/configuration"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"}}}