From 061cd40a3dde20211447a896356eb163f98c9bca Mon Sep 17 00:00:00 2001 From: Distiller Date: Wed, 7 Feb 2024 10:28:24 +0000 Subject: [PATCH] Update documentation for 6.7.1 --- docs/6.7.1/.nojekyll | 1 + docs/6.7.1/assets/highlight.css | 50 + docs/6.7.1/assets/main.js | 58 + docs/6.7.1/assets/search.js | 1 + docs/6.7.1/assets/style.css | 1279 ++++++++++++++ docs/6.7.1/classes/default.html | 1521 +++++++++++++++++ docs/6.7.1/enums/BILLING_FEATURE.html | 105 ++ .../6.7.1/enums/INTRO_ELIGIBILITY_STATUS.html | 91 + docs/6.7.1/enums/LOG_LEVEL.html | 90 + docs/6.7.1/enums/OFFER_PAYMENT_MODE.html | 85 + docs/6.7.1/enums/PACKAGE_TYPE.html | 136 ++ docs/6.7.1/enums/PERIOD_UNIT.html | 93 + docs/6.7.1/enums/PRODUCT_CATEGORY.html | 82 + docs/6.7.1/enums/PRODUCT_TYPE.html | 109 ++ docs/6.7.1/enums/PRORATION_MODE.html | 114 ++ docs/6.7.1/enums/PURCHASES_ERROR_CODE.html | 300 ++++ docs/6.7.1/enums/PURCHASE_TYPE.html | 76 + docs/6.7.1/enums/RECURRENCE_MODE.html | 85 + docs/6.7.1/enums/REFUND_REQUEST_STATUS.html | 82 + docs/6.7.1/index.html | 243 +++ docs/6.7.1/interfaces/CustomerInfo.html | 193 +++ docs/6.7.1/interfaces/ErrorInfo.html | 66 + .../interfaces/GoogleProductChangeInfo.html | 80 + docs/6.7.1/interfaces/IntroEligibility.html | 80 + docs/6.7.1/interfaces/LogInResult.html | 80 + docs/6.7.1/interfaces/Period.html | 91 + docs/6.7.1/interfaces/Price.html | 93 + docs/6.7.1/interfaces/PricingPhase.html | 108 ++ .../interfaces/PurchasesConfiguration.html | 128 ++ .../interfaces/PurchasesEntitlementInfo.html | 244 +++ .../interfaces/PurchasesEntitlementInfos.html | 90 + docs/6.7.1/interfaces/PurchasesError.html | 101 ++ .../6.7.1/interfaces/PurchasesIntroPrice.html | 113 ++ docs/6.7.1/interfaces/PurchasesOffering.html | 170 ++ docs/6.7.1/interfaces/PurchasesOfferings.html | 86 + docs/6.7.1/interfaces/PurchasesPackage.html | 99 ++ .../interfaces/PurchasesPromotionalOffer.html | 94 + .../interfaces/PurchasesStoreProduct.html | 193 +++ .../PurchasesStoreProductDiscount.html | 122 ++ .../interfaces/PurchasesStoreTransaction.html | 90 + docs/6.7.1/interfaces/SubscriptionOption.html | 180 ++ docs/6.7.1/interfaces/UpgradeInfo.html | 81 + docs/6.7.1/modules.html | 133 ++ .../types/CustomerInfoUpdateListener.html | 101 ++ docs/6.7.1/types/LogHandler.html | 99 ++ docs/6.7.1/types/MakePurchaseResult.html | 91 + .../ShouldPurchasePromoProductListener.html | 103 ++ docs/index.html | 2 +- 48 files changed, 7711 insertions(+), 1 deletion(-) create mode 100644 docs/6.7.1/.nojekyll create mode 100644 docs/6.7.1/assets/highlight.css create mode 100644 docs/6.7.1/assets/main.js create mode 100644 docs/6.7.1/assets/search.js create mode 100644 docs/6.7.1/assets/style.css create mode 100644 docs/6.7.1/classes/default.html create mode 100644 docs/6.7.1/enums/BILLING_FEATURE.html create mode 100644 docs/6.7.1/enums/INTRO_ELIGIBILITY_STATUS.html create mode 100644 docs/6.7.1/enums/LOG_LEVEL.html create mode 100644 docs/6.7.1/enums/OFFER_PAYMENT_MODE.html create mode 100644 docs/6.7.1/enums/PACKAGE_TYPE.html create mode 100644 docs/6.7.1/enums/PERIOD_UNIT.html create mode 100644 docs/6.7.1/enums/PRODUCT_CATEGORY.html create mode 100644 docs/6.7.1/enums/PRODUCT_TYPE.html create mode 100644 docs/6.7.1/enums/PRORATION_MODE.html create mode 100644 docs/6.7.1/enums/PURCHASES_ERROR_CODE.html create mode 100644 docs/6.7.1/enums/PURCHASE_TYPE.html create mode 100644 docs/6.7.1/enums/RECURRENCE_MODE.html create mode 100644 docs/6.7.1/enums/REFUND_REQUEST_STATUS.html create mode 100644 docs/6.7.1/index.html create mode 100644 docs/6.7.1/interfaces/CustomerInfo.html create mode 100644 docs/6.7.1/interfaces/ErrorInfo.html create mode 100644 docs/6.7.1/interfaces/GoogleProductChangeInfo.html create mode 100644 docs/6.7.1/interfaces/IntroEligibility.html create mode 100644 docs/6.7.1/interfaces/LogInResult.html create mode 100644 docs/6.7.1/interfaces/Period.html create mode 100644 docs/6.7.1/interfaces/Price.html create mode 100644 docs/6.7.1/interfaces/PricingPhase.html create mode 100644 docs/6.7.1/interfaces/PurchasesConfiguration.html create mode 100644 docs/6.7.1/interfaces/PurchasesEntitlementInfo.html create mode 100644 docs/6.7.1/interfaces/PurchasesEntitlementInfos.html create mode 100644 docs/6.7.1/interfaces/PurchasesError.html create mode 100644 docs/6.7.1/interfaces/PurchasesIntroPrice.html create mode 100644 docs/6.7.1/interfaces/PurchasesOffering.html create mode 100644 docs/6.7.1/interfaces/PurchasesOfferings.html create mode 100644 docs/6.7.1/interfaces/PurchasesPackage.html create mode 100644 docs/6.7.1/interfaces/PurchasesPromotionalOffer.html create mode 100644 docs/6.7.1/interfaces/PurchasesStoreProduct.html create mode 100644 docs/6.7.1/interfaces/PurchasesStoreProductDiscount.html create mode 100644 docs/6.7.1/interfaces/PurchasesStoreTransaction.html create mode 100644 docs/6.7.1/interfaces/SubscriptionOption.html create mode 100644 docs/6.7.1/interfaces/UpgradeInfo.html create mode 100644 docs/6.7.1/modules.html create mode 100644 docs/6.7.1/types/CustomerInfoUpdateListener.html create mode 100644 docs/6.7.1/types/LogHandler.html create mode 100644 docs/6.7.1/types/MakePurchaseResult.html create mode 100644 docs/6.7.1/types/ShouldPurchasePromoProductListener.html diff --git a/docs/6.7.1/.nojekyll b/docs/6.7.1/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/6.7.1/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/6.7.1/assets/highlight.css b/docs/6.7.1/assets/highlight.css new file mode 100644 index 0000000..4c69f15 --- /dev/null +++ b/docs/6.7.1/assets/highlight.css @@ -0,0 +1,50 @@ +:root { + --light-hl-0: #001080; + --dark-hl-0: #9CDCFE; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +pre, code { background: var(--code-background); } diff --git a/docs/6.7.1/assets/main.js b/docs/6.7.1/assets/main.js new file mode 100644 index 0000000..f7c8366 --- /dev/null +++ b/docs/6.7.1/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function fe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/6.7.1/assets/search.js b/docs/6.7.1/assets/search.js new file mode 100644 index 0000000..b924e1d --- /dev/null +++ b/docs/6.7.1/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\"},\"rows\":[{\"kind\":128,\"name\":\"default\",\"url\":\"classes/default.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"PURCHASE_TYPE\",\"url\":\"classes/default.html#PURCHASE_TYPE\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"PRODUCT_CATEGORY\",\"url\":\"classes/default.html#PRODUCT_CATEGORY\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"BILLING_FEATURE\",\"url\":\"classes/default.html#BILLING_FEATURE\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"REFUND_REQUEST_STATUS\",\"url\":\"classes/default.html#REFUND_REQUEST_STATUS\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"PRORATION_MODE\",\"url\":\"classes/default.html#PRORATION_MODE\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"PACKAGE_TYPE\",\"url\":\"classes/default.html#PACKAGE_TYPE\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"INTRO_ELIGIBILITY_STATUS\",\"url\":\"classes/default.html#INTRO_ELIGIBILITY_STATUS\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"PURCHASES_ERROR_CODE\",\"url\":\"classes/default.html#PURCHASES_ERROR_CODE\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"LOG_LEVEL\",\"url\":\"classes/default.html#LOG_LEVEL\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"configure\",\"url\":\"classes/default.html#configure\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAllowSharingStoreAccount\",\"url\":\"classes/default.html#setAllowSharingStoreAccount\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setFinishTransactions\",\"url\":\"classes/default.html#setFinishTransactions\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setSimulatesAskToBuyInSandbox\",\"url\":\"classes/default.html#setSimulatesAskToBuyInSandbox\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"addCustomerInfoUpdateListener\",\"url\":\"classes/default.html#addCustomerInfoUpdateListener\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"removeCustomerInfoUpdateListener\",\"url\":\"classes/default.html#removeCustomerInfoUpdateListener\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"addShouldPurchasePromoProductListener\",\"url\":\"classes/default.html#addShouldPurchasePromoProductListener\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"removeShouldPurchasePromoProductListener\",\"url\":\"classes/default.html#removeShouldPurchasePromoProductListener\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"getOfferings\",\"url\":\"classes/default.html#getOfferings\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"getProducts\",\"url\":\"classes/default.html#getProducts\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchaseProduct\",\"url\":\"classes/default.html#purchaseProduct\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchaseStoreProduct\",\"url\":\"classes/default.html#purchaseStoreProduct\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchaseDiscountedProduct\",\"url\":\"classes/default.html#purchaseDiscountedProduct\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchasePackage\",\"url\":\"classes/default.html#purchasePackage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchaseSubscriptionOption\",\"url\":\"classes/default.html#purchaseSubscriptionOption\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"purchaseDiscountedPackage\",\"url\":\"classes/default.html#purchaseDiscountedPackage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"restorePurchases\",\"url\":\"classes/default.html#restorePurchases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"getAppUserID\",\"url\":\"classes/default.html#getAppUserID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"logIn\",\"url\":\"classes/default.html#logIn\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"logOut\",\"url\":\"classes/default.html#logOut\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setDebugLogsEnabled\",\"url\":\"classes/default.html#setDebugLogsEnabled\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setLogLevel\",\"url\":\"classes/default.html#setLogLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setLogHandler\",\"url\":\"classes/default.html#setLogHandler\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"getCustomerInfo\",\"url\":\"classes/default.html#getCustomerInfo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"syncPurchases\",\"url\":\"classes/default.html#syncPurchases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"syncObserverModeAmazonPurchase\",\"url\":\"classes/default.html#syncObserverModeAmazonPurchase\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAutomaticAppleSearchAdsAttributionCollection\",\"url\":\"classes/default.html#setAutomaticAppleSearchAdsAttributionCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"enableAdServicesAttributionTokenCollection\",\"url\":\"classes/default.html#enableAdServicesAttributionTokenCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"isAnonymous\",\"url\":\"classes/default.html#isAnonymous\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"checkTrialOrIntroductoryPriceEligibility\",\"url\":\"classes/default.html#checkTrialOrIntroductoryPriceEligibility\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"getPromotionalOffer\",\"url\":\"classes/default.html#getPromotionalOffer\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"invalidateCustomerInfoCache\",\"url\":\"classes/default.html#invalidateCustomerInfoCache\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"presentCodeRedemptionSheet\",\"url\":\"classes/default.html#presentCodeRedemptionSheet\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAttributes\",\"url\":\"classes/default.html#setAttributes\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setEmail\",\"url\":\"classes/default.html#setEmail\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setPhoneNumber\",\"url\":\"classes/default.html#setPhoneNumber\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setDisplayName\",\"url\":\"classes/default.html#setDisplayName\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setPushToken\",\"url\":\"classes/default.html#setPushToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setProxyURL\",\"url\":\"classes/default.html#setProxyURL\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"collectDeviceIdentifiers\",\"url\":\"classes/default.html#collectDeviceIdentifiers\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAdjustID\",\"url\":\"classes/default.html#setAdjustID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAppsflyerID\",\"url\":\"classes/default.html#setAppsflyerID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setFBAnonymousID\",\"url\":\"classes/default.html#setFBAnonymousID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setMparticleID\",\"url\":\"classes/default.html#setMparticleID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setCleverTapID\",\"url\":\"classes/default.html#setCleverTapID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setMixpanelDistinctID\",\"url\":\"classes/default.html#setMixpanelDistinctID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setFirebaseAppInstanceID\",\"url\":\"classes/default.html#setFirebaseAppInstanceID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setOnesignalID\",\"url\":\"classes/default.html#setOnesignalID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAirshipChannelID\",\"url\":\"classes/default.html#setAirshipChannelID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setMediaSource\",\"url\":\"classes/default.html#setMediaSource\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setCampaign\",\"url\":\"classes/default.html#setCampaign\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAdGroup\",\"url\":\"classes/default.html#setAdGroup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setAd\",\"url\":\"classes/default.html#setAd\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setKeyword\",\"url\":\"classes/default.html#setKeyword\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"setCreative\",\"url\":\"classes/default.html#setCreative\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"canMakePayments\",\"url\":\"classes/default.html#canMakePayments\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"beginRefundRequestForActiveEntitlement\",\"url\":\"classes/default.html#beginRefundRequestForActiveEntitlement\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"beginRefundRequestForEntitlement\",\"url\":\"classes/default.html#beginRefundRequestForEntitlement\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"beginRefundRequestForProduct\",\"url\":\"classes/default.html#beginRefundRequestForProduct\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"isConfigured\",\"url\":\"classes/default.html#isConfigured\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/default.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"default\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,38.712]],[\"comment/0\",[]],[\"name/1\",[1,38.712]],[\"comment/1\",[]],[\"name/2\",[2,38.712]],[\"comment/2\",[]],[\"name/3\",[3,38.712]],[\"comment/3\",[]],[\"name/4\",[4,38.712]],[\"comment/4\",[]],[\"name/5\",[5,38.712]],[\"comment/5\",[]],[\"name/6\",[6,38.712]],[\"comment/6\",[]],[\"name/7\",[7,38.712]],[\"comment/7\",[]],[\"name/8\",[8,38.712]],[\"comment/8\",[]],[\"name/9\",[9,38.712]],[\"comment/9\",[]],[\"name/10\",[10,38.712]],[\"comment/10\",[]],[\"name/11\",[11,38.712]],[\"comment/11\",[]],[\"name/12\",[12,38.712]],[\"comment/12\",[]],[\"name/13\",[13,38.712]],[\"comment/13\",[]],[\"name/14\",[14,38.712]],[\"comment/14\",[]],[\"name/15\",[15,38.712]],[\"comment/15\",[]],[\"name/16\",[16,38.712]],[\"comment/16\",[]],[\"name/17\",[17,38.712]],[\"comment/17\",[]],[\"name/18\",[18,38.712]],[\"comment/18\",[]],[\"name/19\",[19,38.712]],[\"comment/19\",[]],[\"name/20\",[20,38.712]],[\"comment/20\",[]],[\"name/21\",[21,38.712]],[\"comment/21\",[]],[\"name/22\",[22,38.712]],[\"comment/22\",[]],[\"name/23\",[23,38.712]],[\"comment/23\",[]],[\"name/24\",[24,38.712]],[\"comment/24\",[]],[\"name/25\",[25,38.712]],[\"comment/25\",[]],[\"name/26\",[26,38.712]],[\"comment/26\",[]],[\"name/27\",[27,38.712]],[\"comment/27\",[]],[\"name/28\",[28,38.712]],[\"comment/28\",[]],[\"name/29\",[29,38.712]],[\"comment/29\",[]],[\"name/30\",[30,38.712]],[\"comment/30\",[]],[\"name/31\",[31,38.712]],[\"comment/31\",[]],[\"name/32\",[32,38.712]],[\"comment/32\",[]],[\"name/33\",[33,38.712]],[\"comment/33\",[]],[\"name/34\",[34,38.712]],[\"comment/34\",[]],[\"name/35\",[35,38.712]],[\"comment/35\",[]],[\"name/36\",[36,38.712]],[\"comment/36\",[]],[\"name/37\",[37,38.712]],[\"comment/37\",[]],[\"name/38\",[38,38.712]],[\"comment/38\",[]],[\"name/39\",[39,38.712]],[\"comment/39\",[]],[\"name/40\",[40,38.712]],[\"comment/40\",[]],[\"name/41\",[41,38.712]],[\"comment/41\",[]],[\"name/42\",[42,38.712]],[\"comment/42\",[]],[\"name/43\",[43,38.712]],[\"comment/43\",[]],[\"name/44\",[44,38.712]],[\"comment/44\",[]],[\"name/45\",[45,38.712]],[\"comment/45\",[]],[\"name/46\",[46,38.712]],[\"comment/46\",[]],[\"name/47\",[47,38.712]],[\"comment/47\",[]],[\"name/48\",[48,38.712]],[\"comment/48\",[]],[\"name/49\",[49,38.712]],[\"comment/49\",[]],[\"name/50\",[50,38.712]],[\"comment/50\",[]],[\"name/51\",[51,38.712]],[\"comment/51\",[]],[\"name/52\",[52,38.712]],[\"comment/52\",[]],[\"name/53\",[53,38.712]],[\"comment/53\",[]],[\"name/54\",[54,38.712]],[\"comment/54\",[]],[\"name/55\",[55,38.712]],[\"comment/55\",[]],[\"name/56\",[56,38.712]],[\"comment/56\",[]],[\"name/57\",[57,38.712]],[\"comment/57\",[]],[\"name/58\",[58,38.712]],[\"comment/58\",[]],[\"name/59\",[59,38.712]],[\"comment/59\",[]],[\"name/60\",[60,38.712]],[\"comment/60\",[]],[\"name/61\",[61,38.712]],[\"comment/61\",[]],[\"name/62\",[62,38.712]],[\"comment/62\",[]],[\"name/63\",[63,38.712]],[\"comment/63\",[]],[\"name/64\",[64,38.712]],[\"comment/64\",[]],[\"name/65\",[65,38.712]],[\"comment/65\",[]],[\"name/66\",[66,38.712]],[\"comment/66\",[]],[\"name/67\",[67,38.712]],[\"comment/67\",[]],[\"name/68\",[68,38.712]],[\"comment/68\",[]],[\"name/69\",[69,38.712]],[\"comment/69\",[]],[\"name/70\",[70,38.712]],[\"comment/70\",[]]],\"invertedIndex\":[[\"addcustomerinfoupdatelistener\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"addshouldpurchasepromoproductlistener\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"beginrefundrequestforactiveentitlement\",{\"_index\":66,\"name\":{\"66\":{}},\"comment\":{}}],[\"beginrefundrequestforentitlement\",{\"_index\":67,\"name\":{\"67\":{}},\"comment\":{}}],[\"beginrefundrequestforproduct\",{\"_index\":68,\"name\":{\"68\":{}},\"comment\":{}}],[\"billing_feature\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"canmakepayments\",{\"_index\":65,\"name\":{\"65\":{}},\"comment\":{}}],[\"checktrialorintroductorypriceeligibility\",{\"_index\":39,\"name\":{\"39\":{}},\"comment\":{}}],[\"collectdeviceidentifiers\",{\"_index\":49,\"name\":{\"49\":{}},\"comment\":{}}],[\"configure\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":70,\"name\":{\"70\":{}},\"comment\":{}}],[\"default\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"enableadservicesattributiontokencollection\",{\"_index\":37,\"name\":{\"37\":{}},\"comment\":{}}],[\"getappuserid\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"getcustomerinfo\",{\"_index\":33,\"name\":{\"33\":{}},\"comment\":{}}],[\"getofferings\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"getproducts\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"getpromotionaloffer\",{\"_index\":40,\"name\":{\"40\":{}},\"comment\":{}}],[\"intro_eligibility_status\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"invalidatecustomerinfocache\",{\"_index\":41,\"name\":{\"41\":{}},\"comment\":{}}],[\"isanonymous\",{\"_index\":38,\"name\":{\"38\":{}},\"comment\":{}}],[\"isconfigured\",{\"_index\":69,\"name\":{\"69\":{}},\"comment\":{}}],[\"log_level\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"login\",{\"_index\":28,\"name\":{\"28\":{}},\"comment\":{}}],[\"logout\",{\"_index\":29,\"name\":{\"29\":{}},\"comment\":{}}],[\"package_type\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"presentcoderedemptionsheet\",{\"_index\":42,\"name\":{\"42\":{}},\"comment\":{}}],[\"product_category\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"proration_mode\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"purchase_type\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"purchasediscountedpackage\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"purchasediscountedproduct\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"purchasepackage\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"purchaseproduct\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"purchases_error_code\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"purchasestoreproduct\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"purchasesubscriptionoption\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"refund_request_status\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"removecustomerinfoupdatelistener\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"removeshouldpurchasepromoproductlistener\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"restorepurchases\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"setad\",{\"_index\":62,\"name\":{\"62\":{}},\"comment\":{}}],[\"setadgroup\",{\"_index\":61,\"name\":{\"61\":{}},\"comment\":{}}],[\"setadjustid\",{\"_index\":50,\"name\":{\"50\":{}},\"comment\":{}}],[\"setairshipchannelid\",{\"_index\":58,\"name\":{\"58\":{}},\"comment\":{}}],[\"setallowsharingstoreaccount\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"setappsflyerid\",{\"_index\":51,\"name\":{\"51\":{}},\"comment\":{}}],[\"setattributes\",{\"_index\":43,\"name\":{\"43\":{}},\"comment\":{}}],[\"setautomaticapplesearchadsattributioncollection\",{\"_index\":36,\"name\":{\"36\":{}},\"comment\":{}}],[\"setcampaign\",{\"_index\":60,\"name\":{\"60\":{}},\"comment\":{}}],[\"setclevertapid\",{\"_index\":54,\"name\":{\"54\":{}},\"comment\":{}}],[\"setcreative\",{\"_index\":64,\"name\":{\"64\":{}},\"comment\":{}}],[\"setdebuglogsenabled\",{\"_index\":30,\"name\":{\"30\":{}},\"comment\":{}}],[\"setdisplayname\",{\"_index\":46,\"name\":{\"46\":{}},\"comment\":{}}],[\"setemail\",{\"_index\":44,\"name\":{\"44\":{}},\"comment\":{}}],[\"setfbanonymousid\",{\"_index\":52,\"name\":{\"52\":{}},\"comment\":{}}],[\"setfinishtransactions\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"setfirebaseappinstanceid\",{\"_index\":56,\"name\":{\"56\":{}},\"comment\":{}}],[\"setkeyword\",{\"_index\":63,\"name\":{\"63\":{}},\"comment\":{}}],[\"setloghandler\",{\"_index\":32,\"name\":{\"32\":{}},\"comment\":{}}],[\"setloglevel\",{\"_index\":31,\"name\":{\"31\":{}},\"comment\":{}}],[\"setmediasource\",{\"_index\":59,\"name\":{\"59\":{}},\"comment\":{}}],[\"setmixpaneldistinctid\",{\"_index\":55,\"name\":{\"55\":{}},\"comment\":{}}],[\"setmparticleid\",{\"_index\":53,\"name\":{\"53\":{}},\"comment\":{}}],[\"setonesignalid\",{\"_index\":57,\"name\":{\"57\":{}},\"comment\":{}}],[\"setphonenumber\",{\"_index\":45,\"name\":{\"45\":{}},\"comment\":{}}],[\"setproxyurl\",{\"_index\":48,\"name\":{\"48\":{}},\"comment\":{}}],[\"setpushtoken\",{\"_index\":47,\"name\":{\"47\":{}},\"comment\":{}}],[\"setsimulatesasktobuyinsandbox\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"syncobservermodeamazonpurchase\",{\"_index\":35,\"name\":{\"35\":{}},\"comment\":{}}],[\"syncpurchases\",{\"_index\":34,\"name\":{\"34\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/6.7.1/assets/style.css b/docs/6.7.1/assets/style.css new file mode 100644 index 0000000..496e66f --- /dev/null +++ b/docs/6.7.1/assets/style.css @@ -0,0 +1,1279 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-ts: #db1373; + --light-color-ts-interface: #139d2c; + --light-color-ts-enum: #9c891a; + --light-color-ts-class: #2484e5; + --light-color-ts-function: #572be7; + --light-color-ts-namespace: #b111c9; + --light-color-ts-private: #707070; + --light-color-ts-variable: #4d68ff; + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-ts: #ff6492; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-class: #61b0ff; + --dark-color-ts-function: #9772ff; + --dark-color-ts-namespace: #e14dff; + --dark-color-ts-private: #e2e2e2; + --dark-color-ts-variable: #4d68ff; + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } +} +@media (min-width: 1200px) { + .container { + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; + } +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + display: flex; + justify-content: space-between; + position: relative; + margin: 0 auto; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 2rem 1rem; +} + +.col-4 { + flex: 0 0 25%; +} +.col-8 { + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + padding: 10px; + border: 0.1em solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (max-width: 1024px) { + html .col-content { + float: none; + max-width: 100%; + width: 100%; + padding-top: 3rem; + } + html .col-menu { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel a.tsd-parent-kind-module { + color: var(--color-ts); +} +.tsd-index-panel a.tsd-parent-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-parent-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-parent-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-index-panel a.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-index-panel a.tsd-is-private { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation a { + display: block; + margin: 0.4rem 0; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; +} +.tsd-navigation.primary a { + padding: 0.75rem 0.5rem; + margin: 0; +} +.tsd-navigation.primary ul li a { + margin-left: 0.5rem; +} +.tsd-navigation.primary ul li li a { + margin-left: 1.5rem; +} +.tsd-navigation.primary ul li li li a { + margin-left: 2.5rem; +} +.tsd-navigation.primary ul li li li li a { + margin-left: 3.5rem; +} +.tsd-navigation.primary ul li li li li li a { + margin-left: 4.5rem; +} +.tsd-navigation.primary ul li li li li li li a { + margin-left: 5.5rem; +} +.tsd-navigation.primary li.current > a { + border-left: 0.15rem var(--color-text) solid; +} +.tsd-navigation.primary li.selected > a { + font-weight: bold; + border-left: 0.2rem var(--color-text) solid; +} +.tsd-navigation.primary ul li a:hover { + border-left: 0.2rem var(--color-text-aside) solid; +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 0; +} +.tsd-navigation.secondary ul li li a { + padding-left: 1.1rem; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 2.2rem; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 3.3rem; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 4.4rem; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 5.5rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + margin: 0.25rem 0; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; +} +.tsd-accordion-summary > h1, +.tsd-accordion-summary > h2, +.tsd-accordion-summary > h3, +.tsd-accordion-summary > h4, +.tsd-accordion-summary > h5 { + display: inline-flex; + align-items: center; + vertical-align: middle; + margin-bottom: 0; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; +} +.tsd-accordion-summary { + display: block; + cursor: pointer; +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; +} +.tsd-index-accordion .tsd-accordion-summary svg { + margin-right: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +@media (min-width: 1025px) { + .col-content { + margin: 2rem auto; + } + + .menu-sticky-wrap { + position: sticky; + height: calc(100vh - 2rem); + top: 4rem; + right: 0; + padding: 0 1.5rem; + padding-top: 1rem; + margin-top: 3rem; + transition: 0.3s ease-in-out; + transition-property: top, padding-top, padding, height; + overflow-y: auto; + } + .col-menu { + border-left: 1px solid var(--color-accent); + } + .col-menu--hide { + top: 1rem; + } + .col-menu .tsd-navigation:not(:last-child) { + padding-bottom: 1.75rem; + } +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 1024px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/docs/6.7.1/classes/default.html b/docs/6.7.1/classes/default.html new file mode 100644 index 0000000..26a397f --- /dev/null +++ b/docs/6.7.1/classes/default.html @@ -0,0 +1,1521 @@ +default | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Class default

+
+

Hierarchy

+
    +
  • default
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
BILLING_FEATURE +INTRO_ELIGIBILITY_STATUS +LOG_LEVEL +PACKAGE_TYPE +PRODUCT_CATEGORY +PRORATION_MODE +PURCHASES_ERROR_CODE +PURCHASE_TYPE +REFUND_REQUEST_STATUS +
+
+

Methods

+
addCustomerInfoUpdateListener +addShouldPurchasePromoProductListener +beginRefundRequestForActiveEntitlement +beginRefundRequestForEntitlement +beginRefundRequestForProduct +canMakePayments +checkTrialOrIntroductoryPriceEligibility +collectDeviceIdentifiers +configure +enableAdServicesAttributionTokenCollection +getAppUserID +getCustomerInfo +getOfferings +getProducts +getPromotionalOffer +invalidateCustomerInfoCache +isAnonymous +isConfigured +logIn +logOut +presentCodeRedemptionSheet +purchaseDiscountedPackage +purchaseDiscountedProduct +purchasePackage +purchaseProduct +purchaseStoreProduct +purchaseSubscriptionOption +removeCustomerInfoUpdateListener +removeShouldPurchasePromoProductListener +restorePurchases +setAd +setAdGroup +setAdjustID +setAirshipChannelID +setAllowSharingStoreAccount +setAppsflyerID +setAttributes +setAutomaticAppleSearchAdsAttributionCollection +setCampaign +setCleverTapID +setCreative +setDebugLogsEnabled +setDisplayName +setEmail +setFBAnonymousID +setFinishTransactions +setFirebaseAppInstanceID +setKeyword +setLogHandler +setLogLevel +setMediaSource +setMixpanelDistinctID +setMparticleID +setOnesignalID +setPhoneNumber +setProxyURL +setPushToken +setSimulatesAskToBuyInSandbox +syncObserverModeAmazonPurchase +syncPurchases +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Static Readonly BILLING_FEATURE

+
BILLING_FEATURE: typeof BILLING_FEATURE = BILLING_FEATURE
+

Enum for billing features. +Currently, these are only relevant for Google Play Android users: +https://developer.android.com/reference/com/android/billingclient/api/BillingClient.FeatureType

+
+
+

Static Readonly INTRO_ELIGIBILITY_STATUS

+
INTRO_ELIGIBILITY_STATUS: typeof INTRO_ELIGIBILITY_STATUS = INTRO_ELIGIBILITY_STATUS
+

Enum of different possible states for intro price eligibility status.

+
+
+

Static Readonly LOG_LEVEL

+
LOG_LEVEL: typeof LOG_LEVEL = LOG_LEVEL
+

List of valid log levels.

+
+
+

Static Readonly PACKAGE_TYPE

+
PACKAGE_TYPE: typeof PACKAGE_TYPE = PACKAGE_TYPE
+

Enumeration of all possible Package types.

+
+
+

Static Readonly PRODUCT_CATEGORY

+
PRODUCT_CATEGORY: typeof PRODUCT_CATEGORY = PRODUCT_CATEGORY
+

Supported product categories.

+
+
+

Static Readonly PRORATION_MODE

+
PRORATION_MODE: typeof PRORATION_MODE = PRORATION_MODE
+

Replace SKU's ProrationMode.

+
+
+

Static Readonly PURCHASES_ERROR_CODE

+
PURCHASES_ERROR_CODE: typeof PURCHASES_ERROR_CODE = PURCHASES_ERROR_CODE
+

Enum of all error codes the SDK produces.

+
+
+

Static Readonly PURCHASE_TYPE

+
PURCHASE_TYPE: typeof PURCHASE_TYPE = PURCHASE_TYPE
+

Supported SKU types.

+

@deprecated, use PRODUCT_CATEGORY

+
+
+

Static Readonly REFUND_REQUEST_STATUS

+
REFUND_REQUEST_STATUS: typeof REFUND_REQUEST_STATUS = REFUND_REQUEST_STATUS
+

Enum with possible return states for beginning refund request.

+
+
+

Methods

+
+

Static addCustomerInfoUpdateListener

+
+
+

Static addShouldPurchasePromoProductListener

+
    + +
  • +

    Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS.

    +
    +
    +

    Parameters

    +
      +
    • +
      shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener
      +

      Called when a user initiates a +promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run +the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then +call the deferredPurchase when the app is ready to make the promotional purchase. +If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not +proceed with promotional purchases.

      +
    +

    Returns void

+
+

Static beginRefundRequestForActiveEntitlement

+
    + +
  • +

    iOS 15+ only. Presents a refund request sheet in the current window scene for +the latest transaction associated with the active entitlement.

    +

    If the request was unsuccessful, no active entitlements could be found for +the user, or multiple active entitlements were found for the user, +the promise will return an error. +If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

    +

    Important: This method should only be used if your user can only have a single active entitlement at a given time. +If a user could have more than one entitlement at a time, use beginRefundRequestForEntitlement instead.

    + +

    Returns

    Returns REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED

    +
    +

    Returns Promise<REFUND_REQUEST_STATUS>

+
+

Static beginRefundRequestForEntitlement

+
    + +
  • +

    iOS 15+ only. Presents a refund request sheet in the current window scene for +the latest transaction associated with the entitlement.

    +

    If the request was unsuccessful, the promise will return an error. +If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

    + +

    Returns

    Returns REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<REFUND_REQUEST_STATUS>

+
+

Static beginRefundRequestForProduct

+
    + +
  • +

    iOS 15+ only. Presents a refund request sheet in the current window scene for +the latest transaction associated with the product.

    +

    If the request was unsuccessful, the promise will return an error. +If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

    + +

    Returns

    Returns a REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<REFUND_REQUEST_STATUS>

+
+

Static canMakePayments

+
    + +
  • +

    Check if billing is supported for the current user (meaning IN-APP purchases are supported) +and optionally, whether a list of specified feature types are supported.

    +

    Note: Billing features are only relevant to Google Play Android users. +For other stores and platforms, billing features won't be checked.

    + +

    Returns

    promise with boolean response. True if billing is supported, false otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      features: BILLING_FEATURE[] = []
      +

      An array of feature types to check for support. Feature types must be one of + [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked.

      +
    +

    Returns Promise<boolean>

+
+

Static checkTrialOrIntroductoryPriceEligibility

+
    + +
  • +

    iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product. +You should use this method to determine whether or not you show the user the normal product price or the +introductory price. This also applies to trials (trials are considered a type of introductory pricing).

    + +

    Note

    Subscription groups are automatically collected for determining eligibility. If RevenueCat can't +definitively compute the eligibility, most likely because of missing group information, it will return +INTRO_ELIGIBILITY_STATUS_UNKNOWN. The best course of action on unknown status is to display the non-intro +pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of +iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.

    + +

    Returns

    A map of IntroEligility per productId. The promise +will be rejected if configure has not been called yet or if there's in an error checking eligibility.

    +
    +
    +

    Parameters

    +
      +
    • +
      productIdentifiers: string[]
      +

      Array of product identifiers for which you want to compute eligibility

      +
    +

    Returns Promise<{
        [productId: string]: IntroEligibility;
    }>

+
+

Static collectDeviceIdentifiers

+
    + +
  • +

    Automatically collect subscriber attributes associated with the device identifiers. +$idfa, $idfv, $ip on iOS +$gpsAdId, $androidId, $ip on Android

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting collecting the device identifiers.

    +
    +

    Returns Promise<void>

+
+

Static configure

+
+
+

Static enableAdServicesAttributionTokenCollection

+
    + +
  • +

    Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default

    + +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +

    Returns Promise<void>

+
+

Static getAppUserID

+
    + +
  • +

    Get the appUserID

    + +

    Returns

    The app user id in a promise

    +
    +

    Returns Promise<string>

+
+

Static getCustomerInfo

+
    + +
  • +

    Gets current customer info

    + +

    Returns

    A promise of a customer info object. Rejections return an error code, and an +userInfo object with more information. The promise will be rejected if configure has not been called yet or if +there's an issue getting the customer information.

    +
    +

    Returns Promise<CustomerInfo>

+
+

Static getOfferings

+
    + +
  • +

    Gets the map of entitlements -> offerings -> products

    + +

    Returns

    Promise of entitlements structure. The promise will be rejected if configure +has not been called yet.

    +
    +

    Returns Promise<PurchasesOfferings>

+
+

Static getProducts

+
    + +
  • +

    Fetch the product info

    + +

    Returns

    A promise containing an array of products. The promise will be rejected +if the products are not properly configured in RevenueCat or if there is another error retrieving them. +Rejections return an error code, and a userInfo object with more information. The promise will also be rejected +if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      productIdentifiers: string[]
      +

      Array of product identifiers

      +
      • +
    • +
      type: PURCHASE_TYPE | PRODUCT_CATEGORY = PRODUCT_CATEGORY.SUBSCRIPTION
      +

      Optional type of products to fetch, can be SUBSCRIPTION or NON_SUBSCRIPTION. SUBSCRIPTION by default

      +
    +

    Returns Promise<PurchasesStoreProduct[]>

+
+

Static getPromotionalOffer

+
+
+

Static invalidateCustomerInfoCache

+
    + +
  • +

    Invalidates the cache for customer information.

    +

    Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state. +Refer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on +using the cache properly.

    +

    This is useful for cases where customer information might have been updated outside of the app, like if a +promotional subscription is granted through the RevenueCat dashboard.

    + +

    Returns

    The promise will be rejected if configure has not been called yet or there's an error +invalidating the customer info cache.

    +
    +

    Returns Promise<void>

+
+

Static isAnonymous

+
    + +
  • +
    +

    Returns

    If the appUserID has been generated by RevenueCat or not.

    + +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +

    Returns Promise<boolean>

+
+

Static isConfigured

+
    + +
  • +

    Check if configure has finished and Purchases has been configured.

    + +

    Returns

    promise with boolean response

    +
    +

    Returns Promise<boolean>

+
+

Static logIn

+
    + +
  • +

    This function will logIn the current user with an appUserID. Typically this would be used after a log in +to identify a user without calling configure.

    + +

    Returns

    A promise of an object that contains the customerInfo after logging in, as well +as a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The +promise will be rejected if configure has not been called yet or if there's an issue logging in.

    +
    +
    +

    Parameters

    +
      +
    • +
      appUserID: string
      +

      The appUserID that should be linked to the currently user

      +
    +

    Returns Promise<LogInResult>

+
+

Static logOut

+
    + +
  • +

    Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.

    + +

    Returns

    A promise of a customer info object. Rejections return an error code, +and a userInfo object with more information. The promise will be rejected if configure has not been called yet or if +there's an issue logging out.

    +
    +

    Returns Promise<CustomerInfo>

+
+

Static presentCodeRedemptionSheet

+
    + +
  • +

    iOS only. Presents a code redemption sheet, useful for redeeming offer codes +Refer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how +to configure and use offer codes

    + +

    Returns

    The promise will be rejected if configure has not been called yet or there's an error +presenting the code redemption sheet.

    +
    +

    Returns Promise<void>

+
+

Static purchaseDiscountedPackage

+
    + +
  • +

    iOS only. Purchase a package applying a given discount.

    + +

    Returns

    A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      aPackage: PurchasesPackage
      +

      The Package you wish to purchase. You can get the Packages by calling getOfferings

      +
      • +
    • +
      discount: PurchasesPromotionalOffer
      +

      Discount to apply to this package. Retrieve this discount using getPromotionalOffer.

      +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static purchaseDiscountedProduct

+
    + +
  • +

    iOS only. Purchase a product applying a given discount.

    + +

    Returns

    A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, +a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be +rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static purchasePackage

+
    + +
  • +

    Make a purchase

    + +

    Returns

    A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      aPackage: PurchasesPackage
      +

      The Package you wish to purchase. You can get the Packages by calling getOfferings

      +
      • +
    • +
      Optional upgradeInfo: null | UpgradeInfo
      +

      DEPRECATED. Use googleProductChangeInfo.

      +
      • +
    • +
      Optional googleProductChangeInfo: null | GoogleProductChangeInfo
      +

      Android only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.

      +
      • +
    • +
      Optional googleIsPersonalizedPrice: null | boolean
      +

      Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.

      +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static purchaseProduct

+
    + +
  • +

    Make a purchase

    +
    +
    +

    Parameters

    +
      +
    • +
      productIdentifier: string
      +

      The product identifier of the product you want to purchase

      +
      • +
    • +
      Optional upgradeInfo: null | UpgradeInfo
      +

      Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU +and the optional prorationMode.

      +
      • +
    • +
      type: PURCHASE_TYPE = PURCHASE_TYPE.SUBS
      +

      Optional type of product, can be inapp or subs. Subs by default +@deprecated, use purchaseStoreProduct instead

      +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static purchaseStoreProduct

+
    + +
  • +

    Make a purchase

    + +

    Returns

    A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, +a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will +also be rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      product: PurchasesStoreProduct
      +

      The product you want to purchase

      +
      • +
    • +
      Optional googleProductChangeInfo: null | GoogleProductChangeInfo
      +

      Android only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.

      +
      • +
    • +
      Optional googleIsPersonalizedPrice: null | boolean
      +

      Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.

      +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static purchaseSubscriptionOption

+
    + +
  • +

    Google only. Make a purchase of a subscriptionOption

    + +

    Returns

    A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      subscriptionOption: SubscriptionOption
      +

      The SubscriptionOption you wish to purchase. You can get the SubscriptionOption from StoreProducts by calling getOfferings

      +
      • +
    • +
      Optional googleProductChangeInfo: GoogleProductChangeInfo
      +

      Android only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.

      +
      • +
    • +
      Optional googleIsPersonalizedPrice: boolean
      +

      Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.

      +
    +

    Returns Promise<MakePurchaseResult>

+
+

Static removeCustomerInfoUpdateListener

+
    + +
  • +

    Removes a given CustomerInfoUpdateListener

    + +

    Returns

    True if listener was removed, false otherwise

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

+
+

Static removeShouldPurchasePromoProductListener

+
+
+

Static restorePurchases

+
    + +
  • +

    Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.

    + +

    Returns

    A promise of a customer info object. Rejections return an error code, and an +userInfo object with more information. The promise will be also be rejected if configure has not been called yet.

    +
    +

    Returns Promise<CustomerInfo>

+
+

Static setAd

+
    + +
  • +

    Subscriber attribute associated with the install ad for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the ad subscriber attribute.

    +
    +
    +

    Parameters

    +
      +
    • +
      ad: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setAdGroup

+
    + +
  • +

    Subscriber attribute associated with the install ad group for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting ad group.

    +
    +
    +

    Parameters

    +
      +
    • +
      adGroup: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setAdjustID

+
    + +
  • +

    Subscriber attribute associated with the Adjust Id for the user +Required for the RevenueCat Adjust integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting Adjust ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      adjustID: null | string
      +

      Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setAirshipChannelID

+
    + +
  • +

    Subscriber attribute associated with the Airship Channel Id for the user +Required for the RevenueCat Airship integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Airship Channel ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      airshipChannelID: null | string
      +

      Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setAllowSharingStoreAccount

+
    + +
  • +

    @deprecated, configure behavior through the RevenueCat dashboard instead. +If an user tries to purchase a product that is active on the current app store account, +we will treat it as a restore and alias the new ID with the previous id.

    + +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      allowSharing: boolean
      +

      Set this to true if you are passing in an appUserID but it is anonymous, +this is true by default if you didn't pass an appUserID

      +
    +

    Returns Promise<void>

+
+

Static setAppsflyerID

+
    + +
  • +

    Subscriber attribute associated with the AppsFlyer Id for the user +Required for the RevenueCat AppsFlyer integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Appsflyer ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      appsflyerID: null | string
      +

      Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setAttributes

+
    + +
  • +

    Subscriber attributes are useful for storing additional, structured information on a user. +Since attributes are writable using a public key they should not be used for +managing secure or sensitive information such as subscription status, coins, etc.

    +

    Key names starting with "$" are reserved names used by RevenueCat. For a full list of key +restrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes

    + +

    Returns

    The promise will be rejected if configure has not been called yet or there's an error +setting the subscriber attributes.

    +
    +
    +

    Parameters

    +
      +
    • +
      attributes: {
          [key: string]: string | null;
      }
      +

      Map of attributes by key. Set the value as an empty string to delete an attribute.

      +
      +
        +
      • +
        [key: string]: string | null
    +

    Returns Promise<void>

+
+

Static setAutomaticAppleSearchAdsAttributionCollection

+
    + +
  • +

    @deprecated, use enableAdServicesAttributionTokenCollection instead. +Enable automatic collection of Apple Search Ad attribution. Disabled by default

    + +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      enabled: boolean
      +

      Enable or not automatic apple search ads attribution collection

      +
    +

    Returns Promise<void>

+
+

Static setCampaign

+
    + +
  • +

    Subscriber attribute associated with the install campaign for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the campaign.

    +
    +
    +

    Parameters

    +
      +
    • +
      campaign: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setCleverTapID

+
    + +
  • +

    Subscriber attribute associated with the CleverTap Id for the user +Required for the RevenueCat CleverTap integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the CleverTap ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      cleverTapID: null | string
      +

      CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setCreative

+
    + +
  • +

    Subscriber attribute associated with the install ad creative for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the creative subscriber attribute.

    +
    +
    +

    Parameters

    +
      +
    • +
      creative: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setDebugLogsEnabled

+
    + +
  • +

    Enables/Disables debugs logs

    +
    +
    +

    Parameters

    +
      +
    • +
      enabled: boolean
      +

      Enable or not debug logs +@deprecated, use setLogLevel instead

      +
    +

    Returns Promise<void>

+
+

Static setDisplayName

+
    + +
  • +

    Subscriber attribute associated with the display name for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the display name.

    +
    +
    +

    Parameters

    +
      +
    • +
      displayName: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setEmail

+
    + +
  • +

    Subscriber attribute associated with the email address for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the email.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setFBAnonymousID

+
    + +
  • +

    Subscriber attribute associated with the Facebook SDK Anonymous Id for the user +Recommended for the RevenueCat Facebook integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Facebook Anonymous ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      fbAnonymousID: null | string
      +

      Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setFinishTransactions

+
    + +
  • +
    +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      finishTransactions: boolean
      +

      Set finishTransactions to false if you aren't using Purchases SDK to +make the purchase

      +
    +

    Returns Promise<void>

+
+

Static setFirebaseAppInstanceID

+
    + +
  • +

    Subscriber attribute associated with the Firebase App Instance ID for the user +Required for the RevenueCat Firebase integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Firebase App Instance ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      firebaseAppInstanceID: null | string
      +

      Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setKeyword

+
    + +
  • +

    Subscriber attribute associated with the install keyword for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the keyword.

    +
    +
    +

    Parameters

    +
      +
    • +
      keyword: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setLogHandler

+
    + +
  • +

    Set a custom log handler for redirecting logs to your own logging system. +By default, this sends info, warning, and error messages. +If you wish to receive Debug level messages, see [setLogLevel].

    +
    +
    +

    Parameters

    +
      +
    • +
      logHandler: LogHandler
      +

      It will get called for each log event. +Use this function to redirect the log to your own logging system

      +
    +

    Returns void

+
+

Static setLogLevel

+
    + +
  • +

    Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat. +The default is {LOG_LEVEL.INFO} in release builds and {LOG_LEVEL.DEBUG} in debug builds.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

+
+

Static setMediaSource

+
    + +
  • +

    Subscriber attribute associated with the install media source for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the media source.

    +
    +
    +

    Parameters

    +
      +
    • +
      mediaSource: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setMixpanelDistinctID

+
    + +
  • +

    Subscriber attribute associated with the Mixpanel Distinct Id for the user +Required for the RevenueCat Mixpanel integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Mixpanel Distinct ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      mixpanelDistinctID: null | string
      +

      Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setMparticleID

+
    + +
  • +

    Subscriber attribute associated with the mParticle Id for the user +Recommended for the RevenueCat mParticle integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the Mparticle ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      mparticleID: null | string
      +

      Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setOnesignalID

+
    + +
  • +

    Subscriber attribute associated with the OneSignal Player Id for the user +Required for the RevenueCat OneSignal integration

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the OneSignal ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      onesignalID: null | string
      +

      OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setPhoneNumber

+
    + +
  • +

    Subscriber attribute associated with the phone number for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the phone number.

    +
    +
    +

    Parameters

    +
      +
    • +
      phoneNumber: null | string
      +

      Empty String or null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setProxyURL

+
    + +
  • +

    Set this property to your proxy URL before configuring Purchases only if you've received a proxy key value +from your RevenueCat contact.

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the proxy url.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
    +

    Returns Promise<void>

+
+

Static setPushToken

+
    + +
  • +

    Subscriber attribute associated with the push token for the user

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +setting the push token.

    +
    +
    +

    Parameters

    +
      +
    • +
      pushToken: null | string
      +

      null will delete the subscriber attribute.

      +
    +

    Returns Promise<void>

+
+

Static setSimulatesAskToBuyInSandbox

+
    + +
  • +

    iOS only.

    + +

    Returns

    The promise will be rejected if configure has not been called yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      simulatesAskToBuyInSandbox: boolean
      +

      Set this property to true only when testing the ask-to-buy / SCA +purchases flow. More information: http://errors.rev.cat/ask-to-buy

      +
    +

    Returns Promise<void>

+
+

Static syncObserverModeAmazonPurchase

+
    + +
  • +

    This method will send a purchase to the RevenueCat backend. This function should only be called if you are +in Amazon observer mode or performing a client side migration of your current users to RevenueCat.

    +

    The receipt IDs are cached if successfully posted so they are not posted more than once.

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +syncing purchases.

    +
    +
    +

    Parameters

    +
      +
    • +
      productID: string
      +

      Product ID associated to the purchase.

      +
      • +
    • +
      receiptID: string
      +

      ReceiptId that represents the Amazon purchase.

      +
      • +
    • +
      amazonUserID: string
      +

      Amazon's userID. This parameter will be ignored when syncing a Google purchase.

      +
      • +
    • +
      Optional isoCurrencyCode: null | string
      +

      Product's currency code in ISO 4217 format.

      +
      • +
    • +
      Optional price: null | number
      +

      Product's price.

      +
    +

    Returns Promise<void>

+
+

Static syncPurchases

+
    + +
  • +

    This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation +for subscriptions anytime a sync is needed, like after a successful purchase.

    + +

    Warning

    This function should only be called if you're not calling purchaseProduct/purchaseStoreProduct/purchasePackage/purchaseSubscriptionOption.

    + +

    Returns

    The promise will be rejected if configure has not been called yet or if there's an error +syncing purchases.

    +
    +

    Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/BILLING_FEATURE.html b/docs/6.7.1/enums/BILLING_FEATURE.html new file mode 100644 index 0000000..ea2a96a --- /dev/null +++ b/docs/6.7.1/enums/BILLING_FEATURE.html @@ -0,0 +1,105 @@ +BILLING_FEATURE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration BILLING_FEATURE

+
+

Enum for billing features. +Currently, these are only relevant for Google Play Android users: +https://developer.android.com/reference/com/android/billingclient/api/BillingClient.FeatureType

+
+
+
+
+ +
+
+

Enumeration Members

+
IN_APP_ITEMS_ON_VR +PRICE_CHANGE_CONFIRMATION +SUBSCRIPTIONS +SUBSCRIPTIONS_ON_VR +SUBSCRIPTIONS_UPDATE +
+
+

Enumeration Members

+
+

IN_APP_ITEMS_ON_VR

+
IN_APP_ITEMS_ON_VR: 2
+

Purchase/query for in-app items on VR.

+
+
+

PRICE_CHANGE_CONFIRMATION

+
PRICE_CHANGE_CONFIRMATION: 4
+

Launch a price change confirmation flow.

+
+
+

SUBSCRIPTIONS

+
SUBSCRIPTIONS: 0
+

Purchase/query for subscriptions.

+
+
+

SUBSCRIPTIONS_ON_VR

+
SUBSCRIPTIONS_ON_VR: 3
+

Purchase/query for subscriptions on VR.

+
+
+

SUBSCRIPTIONS_UPDATE

+
SUBSCRIPTIONS_UPDATE: 1
+

Subscriptions update/replace.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/INTRO_ELIGIBILITY_STATUS.html b/docs/6.7.1/enums/INTRO_ELIGIBILITY_STATUS.html new file mode 100644 index 0000000..62f8178 --- /dev/null +++ b/docs/6.7.1/enums/INTRO_ELIGIBILITY_STATUS.html @@ -0,0 +1,91 @@ +INTRO_ELIGIBILITY_STATUS | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration INTRO_ELIGIBILITY_STATUS

+
+
+
+ +
+
+

Enumeration Members

+
INTRO_ELIGIBILITY_STATUS_ELIGIBLE +INTRO_ELIGIBILITY_STATUS_INELIGIBLE +INTRO_ELIGIBILITY_STATUS_NO_INTRO_OFFER_EXISTS +INTRO_ELIGIBILITY_STATUS_UNKNOWN +
+
+

Enumeration Members

+
+

INTRO_ELIGIBILITY_STATUS_ELIGIBLE

+
INTRO_ELIGIBILITY_STATUS_ELIGIBLE: 2
+

The user is eligible for a free trial or intro pricing for this product.

+
+
+

INTRO_ELIGIBILITY_STATUS_INELIGIBLE

+
INTRO_ELIGIBILITY_STATUS_INELIGIBLE: 1
+

The user is not eligible for a free trial or intro pricing for this product.

+
+
+

INTRO_ELIGIBILITY_STATUS_NO_INTRO_OFFER_EXISTS

+
INTRO_ELIGIBILITY_STATUS_NO_INTRO_OFFER_EXISTS: 3
+

There is no free trial or intro pricing for this product.

+
+
+

INTRO_ELIGIBILITY_STATUS_UNKNOWN

+
INTRO_ELIGIBILITY_STATUS_UNKNOWN: 0
+

RevenueCat doesn't have enough information to determine eligibility.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/LOG_LEVEL.html b/docs/6.7.1/enums/LOG_LEVEL.html new file mode 100644 index 0000000..93a09f7 --- /dev/null +++ b/docs/6.7.1/enums/LOG_LEVEL.html @@ -0,0 +1,90 @@ +LOG_LEVEL | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration LOG_LEVEL

+
+
+
+ +
+
+

Enumeration Members

+
DEBUG +ERROR +INFO +VERBOSE +WARN +
+
+

Enumeration Members

+
+

DEBUG

+
DEBUG: "DEBUG"
+
+

ERROR

+
ERROR: "ERROR"
+
+

INFO

+
INFO: "INFO"
+
+

VERBOSE

+
VERBOSE: "VERBOSE"
+
+

WARN

+
WARN: "WARN"
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/OFFER_PAYMENT_MODE.html b/docs/6.7.1/enums/OFFER_PAYMENT_MODE.html new file mode 100644 index 0000000..e2a692f --- /dev/null +++ b/docs/6.7.1/enums/OFFER_PAYMENT_MODE.html @@ -0,0 +1,85 @@ +OFFER_PAYMENT_MODE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration OFFER_PAYMENT_MODE

+
+

Payment mode for offer pricing phases. Google Play only.

+
+
+
+
+ +
+
+

Enumeration Members

+
DISCOUNTED_RECURRING_PAYMENT +FREE_TRIAL +SINGLE_PAYMENT +
+
+

Enumeration Members

+
+

DISCOUNTED_RECURRING_PAYMENT

+
DISCOUNTED_RECURRING_PAYMENT: "DISCOUNTED_RECURRING_PAYMENT"
+

Subscribers pay a discounted amount for a specified number of periods

+
+
+

FREE_TRIAL

+
FREE_TRIAL: "FREE_TRIAL"
+

Subscribers don't pay until the specified period ends

+
+
+

SINGLE_PAYMENT

+
SINGLE_PAYMENT: "SINGLE_PAYMENT"
+

Subscribers pay up front for a specified period

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PACKAGE_TYPE.html b/docs/6.7.1/enums/PACKAGE_TYPE.html new file mode 100644 index 0000000..7746225 --- /dev/null +++ b/docs/6.7.1/enums/PACKAGE_TYPE.html @@ -0,0 +1,136 @@ +PACKAGE_TYPE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PACKAGE_TYPE

+
+
+
+ +
+
+

Enumeration Members

+
ANNUAL +CUSTOM +LIFETIME +MONTHLY +SIX_MONTH +THREE_MONTH +TWO_MONTH +UNKNOWN +WEEKLY +
+
+

Enumeration Members

+
+

ANNUAL

+
ANNUAL: "ANNUAL"
+

A package configured with the predefined annual identifier.

+
+
+

CUSTOM

+
CUSTOM: "CUSTOM"
+

A package that was defined with a custom identifier.

+
+
+

LIFETIME

+
LIFETIME: "LIFETIME"
+

A package configured with the predefined lifetime identifier.

+
+
+

MONTHLY

+
MONTHLY: "MONTHLY"
+

A package configured with the predefined monthly identifier.

+
+
+

SIX_MONTH

+
SIX_MONTH: "SIX_MONTH"
+

A package configured with the predefined six month identifier.

+
+
+

THREE_MONTH

+
THREE_MONTH: "THREE_MONTH"
+

A package configured with the predefined three month identifier.

+
+
+

TWO_MONTH

+
TWO_MONTH: "TWO_MONTH"
+

A package configured with the predefined two month identifier.

+
+
+

UNKNOWN

+
UNKNOWN: "UNKNOWN"
+

A package that was defined with a custom identifier.

+
+
+

WEEKLY

+
WEEKLY: "WEEKLY"
+

A package configured with the predefined weekly identifier.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PERIOD_UNIT.html b/docs/6.7.1/enums/PERIOD_UNIT.html new file mode 100644 index 0000000..ea45ff9 --- /dev/null +++ b/docs/6.7.1/enums/PERIOD_UNIT.html @@ -0,0 +1,93 @@ +PERIOD_UNIT | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PERIOD_UNIT

+
+

Time duration unit for Period.

+
+
+
+
+ +
+
+

Enumeration Members

+
DAY +MONTH +UNKNOWN +WEEK +YEAR +
+
+

Enumeration Members

+
+

DAY

+
DAY: "DAY"
+
+

MONTH

+
MONTH: "MONTH"
+
+

UNKNOWN

+
UNKNOWN: "UNKNOWN"
+
+

WEEK

+
WEEK: "WEEK"
+
+

YEAR

+
YEAR: "YEAR"
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PRODUCT_CATEGORY.html b/docs/6.7.1/enums/PRODUCT_CATEGORY.html new file mode 100644 index 0000000..246c073 --- /dev/null +++ b/docs/6.7.1/enums/PRODUCT_CATEGORY.html @@ -0,0 +1,82 @@ +PRODUCT_CATEGORY | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PRODUCT_CATEGORY

+
+
+
+ +
+
+

Enumeration Members

+
NON_SUBSCRIPTION +SUBSCRIPTION +UNKNOWN +
+
+

Enumeration Members

+
+

NON_SUBSCRIPTION

+
NON_SUBSCRIPTION: "NON_SUBSCRIPTION"
+

A type of product for non-subscription.

+
+
+

SUBSCRIPTION

+
SUBSCRIPTION: "SUBSCRIPTION"
+

A type of product for subscriptions.

+
+
+

UNKNOWN

+
UNKNOWN: "UNKNOWN"
+

A type of product for unknowns.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PRODUCT_TYPE.html b/docs/6.7.1/enums/PRODUCT_TYPE.html new file mode 100644 index 0000000..1717b3b --- /dev/null +++ b/docs/6.7.1/enums/PRODUCT_TYPE.html @@ -0,0 +1,109 @@ +PRODUCT_TYPE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PRODUCT_TYPE

+
+
+
+ +
+
+

Enumeration Members

+
AUTO_RENEWABLE_SUBSCRIPTION +CONSUMABLE +NON_CONSUMABLE +NON_RENEWABLE_SUBSCRIPTION +PREPAID_SUBSCRIPTION +UNKNOWN +
+
+

Enumeration Members

+
+

AUTO_RENEWABLE_SUBSCRIPTION

+
AUTO_RENEWABLE_SUBSCRIPTION: "AUTO_RENEWABLE_SUBSCRIPTION"
+

An auto-renewable subscription.

+
+
+

CONSUMABLE

+
CONSUMABLE: "CONSUMABLE"
+

A consumable in-app purchase.

+
+
+

NON_CONSUMABLE

+
NON_CONSUMABLE: "NON_CONSUMABLE"
+

A non-consumable in-app purchase. Only applies to Apple Store products.

+
+
+

NON_RENEWABLE_SUBSCRIPTION

+
NON_RENEWABLE_SUBSCRIPTION: "NON_RENEWABLE_SUBSCRIPTION"
+

A non-renewing subscription. Only applies to Apple Store products.

+
+
+

PREPAID_SUBSCRIPTION

+
PREPAID_SUBSCRIPTION: "PREPAID_SUBSCRIPTION"
+

A subscription that is pre-paid. Only applies to Google Play products.

+
+
+

UNKNOWN

+
UNKNOWN: "UNKNOWN"
+

Unable to determine product type.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PRORATION_MODE.html b/docs/6.7.1/enums/PRORATION_MODE.html new file mode 100644 index 0000000..5df8417 --- /dev/null +++ b/docs/6.7.1/enums/PRORATION_MODE.html @@ -0,0 +1,114 @@ +PRORATION_MODE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PRORATION_MODE

+
+
+
+ +
+
+

Enumeration Members

+
DEFERRED +IMMEDIATE_AND_CHARGE_FULL_PRICE +IMMEDIATE_AND_CHARGE_PRORATED_PRICE +IMMEDIATE_WITHOUT_PRORATION +IMMEDIATE_WITH_TIME_PRORATION +UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY +
+
+

Enumeration Members

+
+

DEFERRED

+
DEFERRED: 4
+

Replacement takes effect when the old plan expires, and the new price will +be charged at the same time.

+
+
+

IMMEDIATE_AND_CHARGE_FULL_PRICE

+
IMMEDIATE_AND_CHARGE_FULL_PRICE: 5
+

Replacement takes effect immediately, and the user is charged full price +of new plan and is given a full billing cycle of subscription, +plus remaining prorated time from the old plan.

+
+
+

IMMEDIATE_AND_CHARGE_PRORATED_PRICE

+
IMMEDIATE_AND_CHARGE_PRORATED_PRICE: 2
+

Replacement takes effect immediately, and the billing cycle remains the +same. The price for the remaining period will be charged. This option is +only available for subscription upgrade.

+
+
+

IMMEDIATE_WITHOUT_PRORATION

+
IMMEDIATE_WITHOUT_PRORATION: 3
+

Replacement takes effect immediately, and the new price will be charged on +next recurrence time. The billing cycle stays the same.

+
+
+

IMMEDIATE_WITH_TIME_PRORATION

+
IMMEDIATE_WITH_TIME_PRORATION: 1
+

Replacement takes effect immediately, and the remaining time will be +prorated and credited to the user. This is the current default behavior.

+
+
+

UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY

+
UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY: 0
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PURCHASES_ERROR_CODE.html b/docs/6.7.1/enums/PURCHASES_ERROR_CODE.html new file mode 100644 index 0000000..fec88f6 --- /dev/null +++ b/docs/6.7.1/enums/PURCHASES_ERROR_CODE.html @@ -0,0 +1,300 @@ +PURCHASES_ERROR_CODE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PURCHASES_ERROR_CODE

+
+
+
+ +
+
+

Enumeration Members

+
API_ENDPOINT_BLOCKED +BEGIN_REFUND_REQUEST_ERROR +CONFIGURATION_ERROR +CUSTOMER_INFO_ERROR +EMPTY_SUBSCRIBER_ATTRIBUTES_ERROR +INELIGIBLE_ERROR +INSUFFICIENT_PERMISSIONS_ERROR +INVALID_APPLE_SUBSCRIPTION_KEY_ERROR +INVALID_APP_USER_ID_ERROR +INVALID_CREDENTIALS_ERROR +INVALID_PROMOTIONAL_OFFER_ERROR +INVALID_RECEIPT_ERROR +INVALID_SUBSCRIBER_ATTRIBUTES_ERROR +LOG_OUT_ANONYMOUS_USER_ERROR +MISSING_RECEIPT_FILE_ERROR +NETWORK_ERROR +OFFLINE_CONNECTION_ERROR +OPERATION_ALREADY_IN_PROGRESS_ERROR +PAYMENT_PENDING_ERROR +PRODUCT_ALREADY_PURCHASED_ERROR +PRODUCT_DISCOUNT_MISSING_IDENTIFIER_ERROR +PRODUCT_DISCOUNT_MISSING_SUBSCRIPTION_GROUP_IDENTIFIER_ERROR +PRODUCT_NOT_AVAILABLE_FOR_PURCHASE_ERROR +PRODUCT_REQUEST_TIMED_OUT_ERROR +PURCHASE_CANCELLED_ERROR +PURCHASE_INVALID_ERROR +PURCHASE_NOT_ALLOWED_ERROR +RECEIPT_ALREADY_IN_USE_ERROR +RECEIPT_IN_USE_BY_OTHER_SUBSCRIBER_ERROR +STORE_PROBLEM_ERROR +SYSTEM_INFO_ERROR +UNEXPECTED_BACKEND_RESPONSE_ERROR +UNKNOWN_BACKEND_ERROR +UNKNOWN_ERROR +UNSUPPORTED_ERROR +
+
+

Enumeration Members

+
+

API_ENDPOINT_BLOCKED

+
API_ENDPOINT_BLOCKED: "33"
+
+

BEGIN_REFUND_REQUEST_ERROR

+
BEGIN_REFUND_REQUEST_ERROR: "31"
+
+

CONFIGURATION_ERROR

+
CONFIGURATION_ERROR: "23"
+
+

CUSTOMER_INFO_ERROR

+
CUSTOMER_INFO_ERROR: "29"
+
+

EMPTY_SUBSCRIBER_ATTRIBUTES_ERROR

+
EMPTY_SUBSCRIBER_ATTRIBUTES_ERROR: "25"
+
+

INELIGIBLE_ERROR

+
INELIGIBLE_ERROR: "18"
+
+

INSUFFICIENT_PERMISSIONS_ERROR

+
INSUFFICIENT_PERMISSIONS_ERROR: "19"
+
+

INVALID_APPLE_SUBSCRIPTION_KEY_ERROR

+
INVALID_APPLE_SUBSCRIPTION_KEY_ERROR: "17"
+
+

INVALID_APP_USER_ID_ERROR

+
INVALID_APP_USER_ID_ERROR: "14"
+
+

INVALID_CREDENTIALS_ERROR

+
INVALID_CREDENTIALS_ERROR: "11"
+
+

INVALID_PROMOTIONAL_OFFER_ERROR

+
INVALID_PROMOTIONAL_OFFER_ERROR: "34"
+
+

INVALID_RECEIPT_ERROR

+
INVALID_RECEIPT_ERROR: "8"
+
+

INVALID_SUBSCRIBER_ATTRIBUTES_ERROR

+
INVALID_SUBSCRIBER_ATTRIBUTES_ERROR: "21"
+
+

LOG_OUT_ANONYMOUS_USER_ERROR

+
LOG_OUT_ANONYMOUS_USER_ERROR: "22"
+
+

MISSING_RECEIPT_FILE_ERROR

+
MISSING_RECEIPT_FILE_ERROR: "9"
+
+

NETWORK_ERROR

+
NETWORK_ERROR: "10"
+
+

OFFLINE_CONNECTION_ERROR

+
OFFLINE_CONNECTION_ERROR: "35"
+
+

OPERATION_ALREADY_IN_PROGRESS_ERROR

+
OPERATION_ALREADY_IN_PROGRESS_ERROR: "15"
+
+

PAYMENT_PENDING_ERROR

+
PAYMENT_PENDING_ERROR: "20"
+
+

PRODUCT_ALREADY_PURCHASED_ERROR

+
PRODUCT_ALREADY_PURCHASED_ERROR: "6"
+
+

PRODUCT_DISCOUNT_MISSING_IDENTIFIER_ERROR

+
PRODUCT_DISCOUNT_MISSING_IDENTIFIER_ERROR: "26"
+
+

PRODUCT_DISCOUNT_MISSING_SUBSCRIPTION_GROUP_IDENTIFIER_ERROR

+
PRODUCT_DISCOUNT_MISSING_SUBSCRIPTION_GROUP_IDENTIFIER_ERROR: "28"
+
+

PRODUCT_NOT_AVAILABLE_FOR_PURCHASE_ERROR

+
PRODUCT_NOT_AVAILABLE_FOR_PURCHASE_ERROR: "5"
+
+

PRODUCT_REQUEST_TIMED_OUT_ERROR

+
PRODUCT_REQUEST_TIMED_OUT_ERROR: "32"
+
+

PURCHASE_CANCELLED_ERROR

+
PURCHASE_CANCELLED_ERROR: "1"
+
+

PURCHASE_INVALID_ERROR

+
PURCHASE_INVALID_ERROR: "4"
+
+

PURCHASE_NOT_ALLOWED_ERROR

+
PURCHASE_NOT_ALLOWED_ERROR: "3"
+
+

RECEIPT_ALREADY_IN_USE_ERROR

+
RECEIPT_ALREADY_IN_USE_ERROR: "7"
+
+

RECEIPT_IN_USE_BY_OTHER_SUBSCRIBER_ERROR

+
RECEIPT_IN_USE_BY_OTHER_SUBSCRIBER_ERROR: "13"
+
+

STORE_PROBLEM_ERROR

+
STORE_PROBLEM_ERROR: "2"
+
+

SYSTEM_INFO_ERROR

+
SYSTEM_INFO_ERROR: "30"
+
+

UNEXPECTED_BACKEND_RESPONSE_ERROR

+
UNEXPECTED_BACKEND_RESPONSE_ERROR: "12"
+
+

UNKNOWN_BACKEND_ERROR

+
UNKNOWN_BACKEND_ERROR: "16"
+
+

UNKNOWN_ERROR

+
UNKNOWN_ERROR: "0"
+
+

UNSUPPORTED_ERROR

+
UNSUPPORTED_ERROR: "24"
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/PURCHASE_TYPE.html b/docs/6.7.1/enums/PURCHASE_TYPE.html new file mode 100644 index 0000000..c36a67e --- /dev/null +++ b/docs/6.7.1/enums/PURCHASE_TYPE.html @@ -0,0 +1,76 @@ +PURCHASE_TYPE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration PURCHASE_TYPE

+
+

@deprecated, use PRODUCT_CATEGORY

+
+
+
+
+ +
+
+

Enumeration Members

+
INAPP +SUBS +
+
+

Enumeration Members

+
+

INAPP

+
INAPP: "inapp"
+

A type of SKU for in-app products.

+
+
+

SUBS

+
SUBS: "subs"
+

A type of SKU for subscriptions.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/RECURRENCE_MODE.html b/docs/6.7.1/enums/RECURRENCE_MODE.html new file mode 100644 index 0000000..146793d --- /dev/null +++ b/docs/6.7.1/enums/RECURRENCE_MODE.html @@ -0,0 +1,85 @@ +RECURRENCE_MODE | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration RECURRENCE_MODE

+
+

Recurrence mode for a pricing phase

+
+
+
+
+ +
+
+

Enumeration Members

+
FINITE_RECURRING +INFINITE_RECURRING +NON_RECURRING +
+
+

Enumeration Members

+
+

FINITE_RECURRING

+
FINITE_RECURRING: 2
+

Pricing phase repeats for a fixed number of billing periods

+
+
+

INFINITE_RECURRING

+
INFINITE_RECURRING: 1
+

Pricing phase repeats infinitely until cancellation

+
+
+

NON_RECURRING

+
NON_RECURRING: 3
+

Pricing phase does not repeat

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/enums/REFUND_REQUEST_STATUS.html b/docs/6.7.1/enums/REFUND_REQUEST_STATUS.html new file mode 100644 index 0000000..04bf8eb --- /dev/null +++ b/docs/6.7.1/enums/REFUND_REQUEST_STATUS.html @@ -0,0 +1,82 @@ +REFUND_REQUEST_STATUS | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Enumeration REFUND_REQUEST_STATUS

+
+
+
+ +
+
+

Enumeration Members

+
ERROR +SUCCESS +USER_CANCELLED +
+
+

Enumeration Members

+
+

ERROR

+
ERROR: 2
+

There was an error with the request. See message for more details.

+
+
+

SUCCESS

+
SUCCESS: 0
+

Apple has received the refund request.

+
+
+

USER_CANCELLED

+
USER_CANCELLED: 1
+

User canceled submission of the refund request.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/index.html b/docs/6.7.1/index.html new file mode 100644 index 0000000..335266b --- /dev/null +++ b/docs/6.7.1/index.html @@ -0,0 +1,243 @@ +react-native-purchases - v6.7.1
+
+ +
+
+
+
+

react-native-purchases - v6.7.1

+

😻 In-App Subscriptions Made Easy 😻

+ +

License

+

RevenueCat is a powerful, reliable, and free to use in-app purchase server with cross-platform support. Our open-source framework provides a backend and a wrapper around StoreKit and Google Play Billing to make implementing in-app purchases and subscriptions easy.

+

Whether you are building a new app or already have millions of customers, you can use RevenueCat to:

+
    +
  • Fetch products, make purchases, and check subscription status with our native SDKs.
    • +
  • Host and configure products remotely from our dashboard.
    • +
  • Analyze the most important metrics for your app business in one place.
    • +
  • See customer transaction histories, chart lifetime value, and grant promotional subscriptions.
    • +
  • Get notified of real-time events through webhooks.
    • +
  • Send enriched purchase events to analytics and attribution tools with our easy integrations.
    • +
+

Sign up to get started for free.

+ + +

React Native Purchases

+ +

React Native Purchases is the client for the RevenueCat subscription and purchase tracking system. It is an open source framework that provides a wrapper around StoreKit, Google Play Billing and the RevenueCat backend to make implementing in-app purchases in React Native easy.

+ + +

Migrating from React-Native Purchases v4 to v5

+ + + + +

RevenueCat SDK Features

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RevenueCat
✅Server-side receipt validation
➡️Webhooks - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more
🎯Subscription status tracking - know whether a user is subscribed whether they're on iOS, Android or web
📊Analytics - automatic calculation of metrics like conversion, mrr, and churn
📝Online documentation and SDK reference up to date
🔀Integrations - over a dozen integrations to easily send purchase data where you need it
💯Well maintained - frequent releases
📮Great support - Help Center
+ + +

Getting Started

+ +

For more detailed information, you can view our complete documentation at docs.revenuecat.com.

+

Please follow the Quickstart Guide for more information on how to install the SDK.

+

Or view our React Native sample app:

+ + + +

Requirements

+ +

The minimum React Native version this SDK requires is 0.64.

+ + +

SDK Reference

+ +

Our full SDK reference can be found here.

+
+ + +

Installation

+ +

ExpoKit projects of version 33 or higher can successfully use react-native-purchases. If you haven't upgraded, you can follow the instructions here to upgrade.

+
+

❗️ If you're planning on ejecting from Expo, upgrade your expo version first, THEN eject. It'll save you a whole lot of hassle. ❗️

+
+ + +

1. Add the library to the project

+ +
$ npm install react-native-purchases --save
+
+

or

+
$ yarn add react-native-purchases
+
+ + +

2. Link library to the project

+ +
$ react-native link react-native-purchases
+
+ + +

Additional iOS Setup

+ + + +

If your project uses Cocoapods

+ +

If your project already uses Cocoapods to install iOS dependencies, common in ExpoKit projects, linking the library should have added it to the podfile. If it hasn't, add the following to your project's podfile to reference the library from your node_modules folder:

+
pod 'RNPurchases', :path => '../node_modules/react-native-purchases'
    :inhibit_warnings => true
+
+

In your ios folder, run pod install. If you've just upgraded ExpoKit, you might need to upgrade cocoapods to the newest version: sudo gem install cocoapods.

+ + +

Migrating from manual installation (if your project doesn't use CocoapodsCreate)

+ + + +
Remove the Framework Reference from your project
+ +
    +
  1. Remove Purchases.framework and PurchasesHybridCommon.framework from the libraries section of the project.
    2. +
+ + +
Remove iOS Frameworks to Embedded Binaries
+ +
    +
  1. In Xcode, in project manager, select your app target.
    2. +
  2. Select the general tab
    3. +
  3. Look for Purchases.framework and PurchasesHybridCommon.framework in the Embedded Binaries section and remove them.
    4. +
+

Remove $(PROJECT_DIR)/../node_modules/react-native-purchases/ios from Framework Search paths in build settings

+ + +
Remove Strip Frameworks Phase
+ +

During the old manual installation instructions, now deprecated, we indicated to add a build phase to strip fat frameworks.

+
    +
  1. In Xcode, in project manager, select your app target.
    2. +
  2. Open the Build Phases tab
    3. +
  3. Remove the added Strip Frameworks phase
    4. +
  4. Clean Derived Data
    5. +
+ + +
Link static library
+ +

The react-native link command should have added the libRNPurchases.a library to the Linked Frameworks and Libraries section of your app target. If it hasn't add it like this:

+

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/CustomerInfo.html b/docs/6.7.1/interfaces/CustomerInfo.html new file mode 100644 index 0000000..14585d1 --- /dev/null +++ b/docs/6.7.1/interfaces/CustomerInfo.html @@ -0,0 +1,193 @@ +CustomerInfo | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface CustomerInfo

+
+

Hierarchy

+
    +
  • CustomerInfo
+
+
+
+ +
+
+

Properties

+
activeSubscriptions +allExpirationDates +allPurchaseDates +allPurchasedProductIdentifiers +entitlements +firstSeen +latestExpirationDate +managementURL +nonSubscriptionTransactions +originalAppUserId +originalApplicationVersion +originalPurchaseDate +requestDate +
+
+

Properties

+
+

Readonly activeSubscriptions

+
activeSubscriptions: string[]
+

Set of active subscription skus

+
+
+

Readonly allExpirationDates

+
allExpirationDates: {
    [key: string]: string | null;
}
+

Map of skus to expiration dates

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string | null
+
+

Readonly allPurchaseDates

+
allPurchaseDates: {
    [key: string]: string | null;
}
+

Map of skus to purchase dates

+
+
+

Type declaration

+
    +
  • +
    [key: string]: string | null
+
+

Readonly allPurchasedProductIdentifiers

+
allPurchasedProductIdentifiers: string[]
+

Set of purchased skus, active and inactive

+
+
+

Readonly entitlements

+
entitlements: PurchasesEntitlementInfos
+

Entitlements attached to this customer info

+
+
+

Readonly firstSeen

+
firstSeen: string
+

The date this user was first seen in RevenueCat.

+
+
+

Readonly latestExpirationDate

+
latestExpirationDate: null | string
+

The latest expiration date of all purchased skus

+
+
+

Readonly managementURL

+
managementURL: null | string
+

URL to manage the active subscription of the user. If this user has an active iOS +subscription, this will point to the App Store, if the user has an active Play Store subscription +it will point there. If there are no active subscriptions it will be null. +If there are multiple for different platforms, it will point to the device store.

+
+
+

Readonly nonSubscriptionTransactions

+
nonSubscriptionTransactions: PurchasesStoreTransaction[]
+
+

Readonly originalAppUserId

+
originalAppUserId: string
+

The original App User Id recorded for this user.

+
+
+

Readonly originalApplicationVersion

+
originalApplicationVersion: null | string
+

Returns the version number for the version of the application when the +user bought the app. Use this for grandfathering users when migrating +to subscriptions.

+

This corresponds to the value of CFBundleVersion (in iOS) in the +Info.plist file when the purchase was originally made. This is always null +in Android

+
+
+

Readonly originalPurchaseDate

+
originalPurchaseDate: null | string
+

Returns the purchase date for the version of the application when the user bought the app. +Use this for grandfathering users when migrating to subscriptions.

+
+
+

Readonly requestDate

+
requestDate: string
+

Date when this info was requested

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/ErrorInfo.html b/docs/6.7.1/interfaces/ErrorInfo.html new file mode 100644 index 0000000..584936c --- /dev/null +++ b/docs/6.7.1/interfaces/ErrorInfo.html @@ -0,0 +1,66 @@ +ErrorInfo | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface ErrorInfo

+
+

Hierarchy

+
    +
  • ErrorInfo
+
+
+
+ +
+
+

Properties

+
readableErrorCode +
+
+

Properties

+
+

readableErrorCode

+
readableErrorCode: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/GoogleProductChangeInfo.html b/docs/6.7.1/interfaces/GoogleProductChangeInfo.html new file mode 100644 index 0000000..1a4e658 --- /dev/null +++ b/docs/6.7.1/interfaces/GoogleProductChangeInfo.html @@ -0,0 +1,80 @@ +GoogleProductChangeInfo | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface GoogleProductChangeInfo

+
+

Holds the information used when upgrading from another sku. For Android use only.

+
+
+

Hierarchy

+
    +
  • GoogleProductChangeInfo
+
+
+
+ +
+
+

Properties

+
oldProductIdentifier +prorationMode? +
+
+

Properties

+
+

Readonly oldProductIdentifier

+
oldProductIdentifier: string
+

The old product identifier to upgrade from.

+
+
+

Optional Readonly prorationMode

+
prorationMode?: PRORATION_MODE
+

The [PRORATION_MODE] to use when upgrading the given oldSKU.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/IntroEligibility.html b/docs/6.7.1/interfaces/IntroEligibility.html new file mode 100644 index 0000000..3d5f788 --- /dev/null +++ b/docs/6.7.1/interfaces/IntroEligibility.html @@ -0,0 +1,80 @@ +IntroEligibility | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface IntroEligibility

+
+

Holds the introductory price status

+
+
+

Hierarchy

+
    +
  • IntroEligibility
+
+
+
+ +
+
+

Properties

+
description +status +
+
+

Properties

+
+

Readonly description

+
description: string
+

Description of the status

+
+
+

Readonly status

+
status: INTRO_ELIGIBILITY_STATUS
+

The introductory price eligibility status

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/LogInResult.html b/docs/6.7.1/interfaces/LogInResult.html new file mode 100644 index 0000000..636dea3 --- /dev/null +++ b/docs/6.7.1/interfaces/LogInResult.html @@ -0,0 +1,80 @@ +LogInResult | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface LogInResult

+
+

Holds the logIn result

+
+
+

Hierarchy

+
    +
  • LogInResult
+
+
+
+ +
+
+

Properties

+
created +customerInfo +
+
+

Properties

+
+

Readonly created

+
created: boolean
+

True if the call resulted in a new user getting created in the RevenueCat backend.

+
+
+

Readonly customerInfo

+
customerInfo: CustomerInfo
+

The Customer Info for the user.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/Period.html b/docs/6.7.1/interfaces/Period.html new file mode 100644 index 0000000..4bd1834 --- /dev/null +++ b/docs/6.7.1/interfaces/Period.html @@ -0,0 +1,91 @@ +Period | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface Period

+
+

Contains all the details associated with a Period

+
+
+

Hierarchy

+
    +
  • Period
+
+
+
+ +
+
+

Properties

+
iso8601 +unit +value +
+
+

Properties

+
+

Readonly iso8601

+
iso8601: string
+

Specified in ISO 8601 format. For example, P1W equates to one week, +P1M equates to one month, P3M equates to three months, P6M equates to six months, +and P1Y equates to one year

+
+
+

Readonly unit

+
unit: PERIOD_UNIT
+

The number of period units: day, week, month, year, unknown

+
+
+

Readonly value

+
value: number
+

The increment of time that a subscription period is specified in

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/Price.html b/docs/6.7.1/interfaces/Price.html new file mode 100644 index 0000000..b410250 --- /dev/null +++ b/docs/6.7.1/interfaces/Price.html @@ -0,0 +1,93 @@ +Price | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface Price

+
+

Contains all the details associated with a Price

+
+
+

Hierarchy

+
    +
  • Price
+
+
+
+ +
+
+

Properties

+
amountMicros +currencyCode +formatted +
+
+

Properties

+
+

Readonly amountMicros

+
amountMicros: number
+

Price in micro-units, where 1,000,000 micro-units equal one unit of the currency.

+

For example, if price is "€7.99", price_amount_micros is 7,990,000. This value represents +the localized, rounded price for a particular currency.

+
+
+

Readonly currencyCode

+
currencyCode: string
+

Returns ISO 4217 currency code for price and original price.

+

For example, if price is specified in British pounds sterling, price_currency_code is "GBP". +If currency code cannot be determined, currency symbol is returned.

+
+
+

Readonly formatted

+
formatted: string
+

Formatted price of the item, including its currency sign. For example $3.00

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PricingPhase.html b/docs/6.7.1/interfaces/PricingPhase.html new file mode 100644 index 0000000..258a08c --- /dev/null +++ b/docs/6.7.1/interfaces/PricingPhase.html @@ -0,0 +1,108 @@ +PricingPhase | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PricingPhase

+
+

Contains all the details associated with a PricingPhase

+
+
+

Hierarchy

+
    +
  • PricingPhase
+
+
+
+ +
+
+

Properties

+
billingCycleCount +billingPeriod +offerPaymentMode +price +recurrenceMode +
+
+

Properties

+
+

Readonly billingCycleCount

+
billingCycleCount: null | number
+

Number of cycles for which the pricing phase applies. +Null for infiniteRecurring or finiteRecurring recurrence modes.

+
+
+

Readonly billingPeriod

+
billingPeriod: Period
+

Billing period for which the PricingPhase applies

+
+
+

Readonly offerPaymentMode

+
offerPaymentMode: null | OFFER_PAYMENT_MODE
+

Indicates how the pricing phase is charged for finiteRecurring pricing phases

+
+
+

Readonly price

+
price: Price
+

Price of the PricingPhase

+
+
+

Readonly recurrenceMode

+
recurrenceMode: null | RECURRENCE_MODE
+

Recurrence mode of the PricingPhase

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesConfiguration.html b/docs/6.7.1/interfaces/PurchasesConfiguration.html new file mode 100644 index 0000000..c903ed7 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesConfiguration.html @@ -0,0 +1,128 @@ +PurchasesConfiguration | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesConfiguration

+
+

Holds parameters to initialize the SDK.

+
+
+

Hierarchy

+
    +
  • PurchasesConfiguration
+
+
+
+ +
+
+

Properties

+
apiKey +appUserID? +observerMode? +useAmazon? +userDefaultsSuiteName? +usesStoreKit2IfAvailable? +
+
+

Properties

+
+

apiKey

+
apiKey: string
+

RevenueCat API Key. Needs to be a string

+
+
+

Optional appUserID

+
appUserID?: null | string
+

A unique id for identifying the user

+
+
+

Optional observerMode

+
observerMode?: boolean
+

An optional boolean. Set this to TRUE if you have your own IAP implementation and +want to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have +to acknowledge the purchases yourself.

+
+
+

Optional useAmazon

+
useAmazon?: boolean
+

An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.

+
+
+

Optional userDefaultsSuiteName

+
userDefaultsSuiteName?: string
+

An optional string. iOS-only, will be ignored for Android. +Set this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults +suite, otherwise it will use standardUserDefaults. Default is null, which will make the SDK use standardUserDefaults.

+
+
+

Optional usesStoreKit2IfAvailable

+
usesStoreKit2IfAvailable?: boolean
+

iOS-only, will be ignored for Android. +Set this to TRUE to enable StoreKit2. +Default is FALSE.

+ +

Deprecated

RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has +proven to be more performant than StoreKit 2. +We're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail +that you shouldn't need to care about. +We recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesEntitlementInfo.html b/docs/6.7.1/interfaces/PurchasesEntitlementInfo.html new file mode 100644 index 0000000..b9c8f3e --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesEntitlementInfo.html @@ -0,0 +1,244 @@ +PurchasesEntitlementInfo | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesEntitlementInfo

+
+

The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.

+
+
+

Hierarchy

+
    +
  • PurchasesEntitlementInfo
+
+
+
+ +
+
+

Properties

+
billingIssueDetectedAt +billingIssueDetectedAtMillis +expirationDate +expirationDateMillis +identifier +isActive +isSandbox +latestPurchaseDate +latestPurchaseDateMillis +originalPurchaseDate +originalPurchaseDateMillis +ownershipType +periodType +productIdentifier +productPlanIdentifier +store +unsubscribeDetectedAt +unsubscribeDetectedAtMillis +willRenew +
+
+

Properties

+
+

Readonly billingIssueDetectedAt

+
billingIssueDetectedAt: null | string
+

The date a billing issue was detected in ISO8601 format. Can be null if there is no billing issue or an +issue has been resolved

+

@note: Entitlement may still be active even if there is a billing issue. Check the isActive property.

+
+
+

Readonly billingIssueDetectedAtMillis

+
billingIssueDetectedAtMillis: null | number
+

The date a billing issue was detected in milliseconds. Can be null if there is no billing issue or an +issue has been resolved

+

@note: Entitlement may still be active even if there is a billing issue. Check the isActive property.

+
+
+

Readonly expirationDate

+
expirationDate: null | string
+

The expiration date for the entitlement in ISO8601, can be null for lifetime access. +If the periodType is trial, this is the trial expiration date.

+
+
+

Readonly expirationDateMillis

+
expirationDateMillis: null | number
+

The expiration date for the entitlement in milliseconds, can be null for lifetime access. +If the periodType is trial, this is the trial expiration date.

+
+
+

Readonly identifier

+
identifier: string
+

The entitlement identifier configured in the RevenueCat dashboard

+
+
+

Readonly isActive

+
isActive: boolean
+

True if the user has access to this entitlement

+
+
+

Readonly isSandbox

+
isSandbox: boolean
+

False if this entitlement is unlocked via a production purchase

+
+
+

Readonly latestPurchaseDate

+
latestPurchaseDate: string
+

The latest purchase or renewal date for the entitlement in ISO8601 format.

+
+
+

Readonly latestPurchaseDateMillis

+
latestPurchaseDateMillis: number
+

The latest purchase or renewal date for the entitlement in milliseconds.

+
+
+

Readonly originalPurchaseDate

+
originalPurchaseDate: string
+

The first date this entitlement was purchased in ISO8601 format.

+
+
+

Readonly originalPurchaseDateMillis

+
originalPurchaseDateMillis: number
+

The first date this entitlement was purchased in milliseconds.

+
+
+

Readonly ownershipType

+
ownershipType: "FAMILY_SHARED" | "PURCHASED" | "UNKNOWN"
+

Supported ownership types for an entitlement. +PURCHASED if the purchase was made directly by this user. +FAMILY_SHARED if the purchase has been shared to this user by a family member. +UNKNOWN if the purchase has no or an unknown ownership type.

+
+
+

Readonly periodType

+
periodType: string
+

The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.

+
+
+

Readonly productIdentifier

+
productIdentifier: string
+

The product identifier that unlocked this entitlement

+
+
+

Readonly productPlanIdentifier

+
productPlanIdentifier: null | string
+

The product plan identifier that unlocked this entitlement. Android subscriptions only, null on consumables and iOS.

+
+
+

Readonly store

+
store: "PLAY_STORE" | "APP_STORE" | "STRIPE" | "MAC_APP_STORE" | "PROMOTIONAL" | "AMAZON" | "UNKNOWN_STORE"
+

The store where this entitlement was unlocked from.

+
+
+

Readonly unsubscribeDetectedAt

+
unsubscribeDetectedAt: null | string
+

The date an unsubscribe was detected in ISO8601 format. Can be null.

+

@note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.

+
+
+

Readonly unsubscribeDetectedAtMillis

+
unsubscribeDetectedAtMillis: null | number
+

The date an unsubscribe was detected in milliseconds. Can be null.

+

@note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.

+
+
+

Readonly willRenew

+
willRenew: boolean
+

True if the underlying subscription is set to renew at the end of the billing period (expirationDate).

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesEntitlementInfos.html b/docs/6.7.1/interfaces/PurchasesEntitlementInfos.html new file mode 100644 index 0000000..bbefd0d --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesEntitlementInfos.html @@ -0,0 +1,90 @@ +PurchasesEntitlementInfos | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesEntitlementInfos

+
+

Contains all the entitlements associated to the user.

+
+
+

Hierarchy

+
    +
  • PurchasesEntitlementInfos
+
+
+
+ +
+
+

Properties

+
active +all +
+
+

Properties

+
+

Readonly active

+
active: {
    [key: string]: PurchasesEntitlementInfo;
}
+

Map of active EntitlementInfo (PurchasesEntitlementInfo) objects keyed by entitlement identifier.

+
+
+

Type declaration

+
+
+

Readonly all

+
all: {
    [key: string]: PurchasesEntitlementInfo;
}
+

Map of all EntitlementInfo (PurchasesEntitlementInfo) objects (active and inactive) keyed by entitlement identifier.

+
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesError.html b/docs/6.7.1/interfaces/PurchasesError.html new file mode 100644 index 0000000..d3fe33f --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesError.html @@ -0,0 +1,101 @@ +PurchasesError | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesError

+
+

Hierarchy

+
    +
  • PurchasesError
+
+
+
+ +
+
+

Properties

+
code +message +readableErrorCode +underlyingErrorMessage +userCancelled +userInfo +
+
+

Properties

+
+

code

+
code: PURCHASES_ERROR_CODE
+
+

message

+
message: string
+
+

readableErrorCode

+
readableErrorCode: string
+
+

underlyingErrorMessage

+
underlyingErrorMessage: string
+
+

userCancelled

+
userCancelled: null | boolean
+
+

userInfo

+
userInfo: ErrorInfo
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesIntroPrice.html b/docs/6.7.1/interfaces/PurchasesIntroPrice.html new file mode 100644 index 0000000..281e909 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesIntroPrice.html @@ -0,0 +1,113 @@ +PurchasesIntroPrice | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesIntroPrice

+
+

Hierarchy

+
    +
  • PurchasesIntroPrice
+
+
+
+ +
+
+

Properties

+
cycles +period +periodNumberOfUnits +periodUnit +price +priceString +
+
+

Properties

+
+

Readonly cycles

+
cycles: number
+

Number of subscription billing periods for which the user will be given the discount, such as 3.

+
+
+

Readonly period

+
period: string
+

Billing period of the discount, specified in ISO 8601 format.

+
+
+

Readonly periodNumberOfUnits

+
periodNumberOfUnits: number
+

Number of units for the billing period of the discount.

+
+
+

Readonly periodUnit

+
periodUnit: string
+

Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.

+
+
+

Readonly price

+
price: number
+

Price in the local currency.

+
+
+

Readonly priceString

+
priceString: string
+

Formatted price, including its currency sign, such as €3.99.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesOffering.html b/docs/6.7.1/interfaces/PurchasesOffering.html new file mode 100644 index 0000000..ae623e0 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesOffering.html @@ -0,0 +1,170 @@ +PurchasesOffering | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesOffering

+
+

An offering is a collection of Packages (PurchasesPackage) available for the user to purchase. +For more info see https://docs.revenuecat.com/docs/entitlements

+
+
+

Hierarchy

+
    +
  • PurchasesOffering
+
+
+
+ +
+
+

Properties

+
annual +availablePackages +identifier +lifetime +metadata +monthly +serverDescription +sixMonth +threeMonth +twoMonth +weekly +
+
+

Properties

+
+

Readonly annual

+
annual: null | PurchasesPackage
+

Annual package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly availablePackages

+
availablePackages: PurchasesPackage[]
+

Array of Package objects available for purchase.

+
+
+

Readonly identifier

+
identifier: string
+

Unique identifier defined in RevenueCat dashboard.

+
+
+

Readonly lifetime

+
lifetime: null | PurchasesPackage
+

Lifetime package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly metadata

+
metadata: {
    [key: string]: unknown;
}
+

Offering metadata defined in RevenueCat dashboard. To access values, you need +to check the type beforehand. For example: +const my_unknown_value: unknown = offering.metadata['my_key']; +const my_string_value: string | undefined = typeof(my_unknown_value) === 'string' ? my_unknown_value : undefined;

+
+
+

Type declaration

+
    +
  • +
    [key: string]: unknown
+
+

Readonly monthly

+
monthly: null | PurchasesPackage
+

Monthly package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly serverDescription

+
serverDescription: string
+

Offering description defined in RevenueCat dashboard.

+
+
+

Readonly sixMonth

+
sixMonth: null | PurchasesPackage
+

Six month package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly threeMonth

+
threeMonth: null | PurchasesPackage
+

Three month package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly twoMonth

+
twoMonth: null | PurchasesPackage
+

Two month package type configured in the RevenueCat dashboard, if available.

+
+
+

Readonly weekly

+
weekly: null | PurchasesPackage
+

Weekly package type configured in the RevenueCat dashboard, if available.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesOfferings.html b/docs/6.7.1/interfaces/PurchasesOfferings.html new file mode 100644 index 0000000..6760684 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesOfferings.html @@ -0,0 +1,86 @@ +PurchasesOfferings | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesOfferings

+
+

Contains all the offerings configured in RevenueCat dashboard. +For more info see https://docs.revenuecat.com/docs/entitlements

+
+
+

Hierarchy

+
    +
  • PurchasesOfferings
+
+
+
+ +
+
+

Properties

+
all +current +
+
+

Properties

+
+

Readonly all

+
all: {
    [key: string]: PurchasesOffering;
}
+

Map of all Offerings [PurchasesOffering] objects keyed by their identifier.

+
+
+

Type declaration

+
+
+

Readonly current

+
current: null | PurchasesOffering
+

Current offering configured in the RevenueCat dashboard.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesPackage.html b/docs/6.7.1/interfaces/PurchasesPackage.html new file mode 100644 index 0000000..8610162 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesPackage.html @@ -0,0 +1,99 @@ +PurchasesPackage | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesPackage

+
+

Contains information about the product available for the user to purchase. +For more info see https://docs.revenuecat.com/docs/entitlements

+
+
+

Hierarchy

+
    +
  • PurchasesPackage
+
+
+
+ +
+
+

Properties

+
identifier +offeringIdentifier +packageType +product +
+
+

Properties

+
+

Readonly identifier

+
identifier: string
+

Unique identifier for this package. Can be one a predefined package type or a custom one.

+
+
+

Readonly offeringIdentifier

+
offeringIdentifier: string
+

Offering this package belongs to.

+
+
+

Readonly packageType

+
packageType: PACKAGE_TYPE
+

Package type for the product. Will be one of [PACKAGE_TYPE].

+
+
+

Readonly product

+
product: PurchasesStoreProduct
+

Product assigned to this package.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesPromotionalOffer.html b/docs/6.7.1/interfaces/PurchasesPromotionalOffer.html new file mode 100644 index 0000000..68600e5 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesPromotionalOffer.html @@ -0,0 +1,94 @@ +PurchasesPromotionalOffer | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesPromotionalOffer

+
+

Hierarchy

+
    +
  • PurchasesPromotionalOffer
+
+
+
+ +
+
+

Properties

+
identifier +keyIdentifier +nonce +signature +timestamp +
+
+

Properties

+
+

Readonly identifier

+
identifier: string
+
+

Readonly keyIdentifier

+
keyIdentifier: string
+
+

Readonly nonce

+
nonce: string
+
+

Readonly signature

+
signature: string
+
+

Readonly timestamp

+
timestamp: number
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesStoreProduct.html b/docs/6.7.1/interfaces/PurchasesStoreProduct.html new file mode 100644 index 0000000..dcd65a6 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesStoreProduct.html @@ -0,0 +1,193 @@ +PurchasesStoreProduct | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesStoreProduct

+
+

Hierarchy

+
    +
  • PurchasesStoreProduct
+
+
+
+ +
+
+

Properties

+
currencyCode +defaultOption +description +discounts +identifier +introPrice +presentedOfferingIdentifier +price +priceString +productCategory +productType +subscriptionOptions +subscriptionPeriod +title +
+
+

Properties

+
+

Readonly currencyCode

+
currencyCode: string
+

Currency code for price and original price. +Contains the currency code value of defaultOption for Google Play.

+
+
+

Readonly defaultOption

+
defaultOption: null | SubscriptionOption
+

Default subscription option for a product. Google Play only.

+
+
+

Readonly description

+
description: string
+

Description of the product.

+
+
+

Readonly discounts

+
discounts: null | PurchasesStoreProductDiscount[]
+

Collection of discount offers for a product. Null for Android.

+
+
+

Readonly identifier

+
identifier: string
+

Product Id.

+
+
+

Readonly introPrice

+
introPrice: null | PurchasesIntroPrice
+

Introductory price.

+
+
+

Readonly presentedOfferingIdentifier

+
presentedOfferingIdentifier: null | string
+

Offering identifier the store product was presented from. +Null if not using offerings or if fetched directly from store via getProducts.

+
+
+

Readonly price

+
price: number
+

Price of the product in the local currency. +Contains the price value of defaultOption for Google Play.

+
+
+

Readonly priceString

+
priceString: string
+

Formatted price of the item, including its currency sign. +Contains the formatted price value of defaultOption for Google Play.

+
+
+

Readonly productCategory

+
productCategory: null | PRODUCT_CATEGORY
+

Product category.

+
+
+

Readonly productType

+
productType: PRODUCT_TYPE
+

The specific type of subscription or one time purchase this product represents

+
+
+

Readonly subscriptionOptions

+
subscriptionOptions: null | SubscriptionOption[]
+

Collection of subscription options for a product. Google Play only.

+
+
+

Readonly subscriptionPeriod

+
subscriptionPeriod: null | string
+

Subscription period, specified in ISO 8601 format. For example, +P1W equates to one week, P1M equates to one month, +P3M equates to three months, P6M equates to six months, +and P1Y equates to one year. +Note: Not available for Amazon.

+
+
+

Readonly title

+
title: string
+

Title of the product.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesStoreProductDiscount.html b/docs/6.7.1/interfaces/PurchasesStoreProductDiscount.html new file mode 100644 index 0000000..e54da9c --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesStoreProductDiscount.html @@ -0,0 +1,122 @@ +PurchasesStoreProductDiscount | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesStoreProductDiscount

+
+

Hierarchy

+
    +
  • PurchasesStoreProductDiscount
+
+
+
+ +
+
+

Properties

+
cycles +identifier +period +periodNumberOfUnits +periodUnit +price +priceString +
+
+

Properties

+
+

Readonly cycles

+
cycles: number
+

Number of subscription billing periods for which the user will be given the discount, such as 3.

+
+
+

Readonly identifier

+
identifier: string
+

Identifier of the discount.

+
+
+

Readonly period

+
period: string
+

Billing period of the discount, specified in ISO 8601 format.

+
+
+

Readonly periodNumberOfUnits

+
periodNumberOfUnits: number
+

Number of units for the billing period of the discount.

+
+
+

Readonly periodUnit

+
periodUnit: string
+

Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.

+
+
+

Readonly price

+
price: number
+

Price in the local currency.

+
+
+

Readonly priceString

+
priceString: string
+

Formatted price, including its currency sign, such as €3.99.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/PurchasesStoreTransaction.html b/docs/6.7.1/interfaces/PurchasesStoreTransaction.html new file mode 100644 index 0000000..3360b16 --- /dev/null +++ b/docs/6.7.1/interfaces/PurchasesStoreTransaction.html @@ -0,0 +1,90 @@ +PurchasesStoreTransaction | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface PurchasesStoreTransaction

+
+

List of all non subscription transactions. Use this to fetch the history of +non-subscription purchases

+
+
+

Hierarchy

+
    +
  • PurchasesStoreTransaction
+
+
+
+ +
+
+

Properties

+
productIdentifier +purchaseDate +transactionIdentifier +
+
+

Properties

+
+

productIdentifier

+
productIdentifier: string
+

Product Id associated with the transaction.

+
+
+

purchaseDate

+
purchaseDate: string
+

Purchase date of the transaction in ISO 8601 format.

+
+
+

transactionIdentifier

+
transactionIdentifier: string
+

Id of the transaction.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/SubscriptionOption.html b/docs/6.7.1/interfaces/SubscriptionOption.html new file mode 100644 index 0000000..35fca7b --- /dev/null +++ b/docs/6.7.1/interfaces/SubscriptionOption.html @@ -0,0 +1,180 @@ +SubscriptionOption | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface SubscriptionOption

+
+

Contains all details associated with a SubscriptionOption +Used only for Google

+
+
+

Hierarchy

+
    +
  • SubscriptionOption
+
+
+
+ +
+
+

Properties

+
billingPeriod +freePhase +fullPricePhase +id +introPhase +isBasePlan +isPrepaid +presentedOfferingIdentifier +pricingPhases +productId +storeProductId +tags +
+
+

Properties

+
+

Readonly billingPeriod

+
billingPeriod: null | Period
+

The subscription period of fullPricePhase (after free and intro trials).

+
+
+

Readonly freePhase

+
freePhase: null | PricingPhase
+

The free trial PricingPhase of the subscription. +Looks for the first pricing phase of the SubscriptionOption where amountMicros is 0. +There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.

+
+
+

Readonly fullPricePhase

+
fullPricePhase: null | PricingPhase
+

The full price PricingPhase of the subscription. +Looks for the last price phase of the SubscriptionOption.

+
+
+

Readonly id

+
id: string
+

Identifier of the subscription option +If this SubscriptionOption represents a base plan, this will be the basePlanId. +If it represents an offer, it will be {basePlanId}:{offerId}

+
+
+

Readonly introPhase

+
introPhase: null | PricingPhase
+

The intro trial PricingPhase of the subscription. +Looks for the first pricing phase of the SubscriptionOption where amountMicros is greater than 0. +There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.

+
+
+

Readonly isBasePlan

+
isBasePlan: boolean
+

True if this SubscriptionOption represents a subscription base plan (rather than an offer).

+
+
+

Readonly isPrepaid

+
isPrepaid: boolean
+

True if the subscription is pre-paid.

+
+
+

Readonly presentedOfferingIdentifier

+
presentedOfferingIdentifier: null | string
+

Offering identifier the subscription option was presented from

+
+
+

Readonly pricingPhases

+
pricingPhases: PricingPhase[]
+

Pricing phases defining a user's payment plan for the product over time.

+
+
+

Readonly productId

+
productId: string
+

Identifer of the subscription associated with this SubscriptionOption +This will be {subId}

+
+
+

Readonly storeProductId

+
storeProductId: string
+

Identifier of the StoreProduct associated with this SubscriptionOption +This will be {subId}:{basePlanId}

+
+
+

Readonly tags

+
tags: string[]
+

Tags defined on the base plan or offer. Empty for Amazon.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/interfaces/UpgradeInfo.html b/docs/6.7.1/interfaces/UpgradeInfo.html new file mode 100644 index 0000000..e597579 --- /dev/null +++ b/docs/6.7.1/interfaces/UpgradeInfo.html @@ -0,0 +1,81 @@ +UpgradeInfo | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Interface UpgradeInfo

+
+

Holds the information used when upgrading from another sku. For Android use only. +@deprecated, use GoogleProductChangeInfo

+
+
+

Hierarchy

+
    +
  • UpgradeInfo
+
+
+
+ +
+
+

Properties

+
oldSKU +prorationMode? +
+
+

Properties

+
+

Readonly oldSKU

+
oldSKU: string
+

The oldSKU to upgrade from.

+
+
+

Optional Readonly prorationMode

+
prorationMode?: PRORATION_MODE
+

The [PRORATION_MODE] to use when upgrading the given oldSKU.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/modules.html b/docs/6.7.1/modules.html new file mode 100644 index 0000000..8890275 --- /dev/null +++ b/docs/6.7.1/modules.html @@ -0,0 +1,133 @@ +react-native-purchases - v6.7.1
+
+ +
+
+
+
+

react-native-purchases - v6.7.1

+
+
+

Index

+
+

Enumerations

+
BILLING_FEATURE +INTRO_ELIGIBILITY_STATUS +LOG_LEVEL +OFFER_PAYMENT_MODE +PACKAGE_TYPE +PERIOD_UNIT +PRODUCT_CATEGORY +PRODUCT_TYPE +PRORATION_MODE +PURCHASES_ERROR_CODE +PURCHASE_TYPE +RECURRENCE_MODE +REFUND_REQUEST_STATUS +
+
+

Classes

+
default +
+
+

Interfaces

+
CustomerInfo +ErrorInfo +GoogleProductChangeInfo +IntroEligibility +LogInResult +Period +Price +PricingPhase +PurchasesConfiguration +PurchasesEntitlementInfo +PurchasesEntitlementInfos +PurchasesError +PurchasesIntroPrice +PurchasesOffering +PurchasesOfferings +PurchasesPackage +PurchasesPromotionalOffer +PurchasesStoreProduct +PurchasesStoreProductDiscount +PurchasesStoreTransaction +SubscriptionOption +UpgradeInfo +
+
+

Type Aliases

+
CustomerInfoUpdateListener +LogHandler +MakePurchaseResult +ShouldPurchasePromoProductListener +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/types/CustomerInfoUpdateListener.html b/docs/6.7.1/types/CustomerInfoUpdateListener.html new file mode 100644 index 0000000..9235673 --- /dev/null +++ b/docs/6.7.1/types/CustomerInfoUpdateListener.html @@ -0,0 +1,101 @@ +CustomerInfoUpdateListener | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Type alias CustomerInfoUpdateListener

+
CustomerInfoUpdateListener: ((customerInfo: CustomerInfo) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (customerInfo: CustomerInfo): void
      • +
    • +

      Listener used on updated customer info

      +
      +
      +

      Parameters

      +
        +
      • +
        customerInfo: CustomerInfo
        +

        Object containing info for the customer

        +
      +

      Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/types/LogHandler.html b/docs/6.7.1/types/LogHandler.html new file mode 100644 index 0000000..73c2183 --- /dev/null +++ b/docs/6.7.1/types/LogHandler.html @@ -0,0 +1,99 @@ +LogHandler | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Type alias LogHandler

+
LogHandler: ((logLevel: LOG_LEVEL, message: string) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (logLevel: LOG_LEVEL, message: string): void
      • +
    • +
      +

      Parameters

      +
      +

      Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/types/MakePurchaseResult.html b/docs/6.7.1/types/MakePurchaseResult.html new file mode 100644 index 0000000..bd06833 --- /dev/null +++ b/docs/6.7.1/types/MakePurchaseResult.html @@ -0,0 +1,91 @@ +MakePurchaseResult | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Type alias MakePurchaseResult

+
MakePurchaseResult: {
    customerInfo: CustomerInfo;
    productIdentifier: string;
}
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/6.7.1/types/ShouldPurchasePromoProductListener.html b/docs/6.7.1/types/ShouldPurchasePromoProductListener.html new file mode 100644 index 0000000..9d7fcd1 --- /dev/null +++ b/docs/6.7.1/types/ShouldPurchasePromoProductListener.html @@ -0,0 +1,103 @@ +ShouldPurchasePromoProductListener | react-native-purchases - v6.7.1
+
+ +
+
+
+
+ +

Type alias ShouldPurchasePromoProductListener

+
ShouldPurchasePromoProductListener: ((deferredPurchase: (() => Promise<MakePurchaseResult>)) => void)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c122009..c54f05e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - +