API Reference
Class
QrPayloads
Helpers for building common QR payloads with recommended defaults.
Inheritance
- Object
- QrPayloads
Examples
using CodeGlyphX;
using CodeGlyphX.Payloads;
QR.Save(QrPayloads.Wifi("MyNetwork", "Password123"), "wifi.png");
Methods
public static QrPayloadData AppStore(String appIdOrUrl, QrAppStorePlatform platform = Apple) #Returns:
QrPayloadDataBuilds an App Store payload for the given platform.
Parameters
- appIdOrUrl System.String
- platform CodeGlyphX.Payloads.QrAppStorePlatform = Apple
public static QrPayloadData AppStoreApple(String appId, String countryCode = null) #Returns:
QrPayloadDataBuilds an Apple App Store payload.
Parameters
- appId System.String
- countryCode System.String = null
public static QrPayloadData AppStoreGooglePlay(String packageId) #Returns:
QrPayloadDataBuilds a Google Play payload.
Parameters
- packageId System.String
public static QrPayloadData BezahlCode(QrBezahlAuthorityType authority, String name, String account = "", String bnc = "", String iban = "", String bic = "", String reason = "") #Returns:
QrPayloadDataBuilds a BezahlCode payload (contact).
Parameters
- authority CodeGlyphX.Payloads.QrBezahlAuthorityType
- name System.String
- account System.String = ""
- bnc System.String = ""
- iban System.String = ""
- bic System.String = ""
- reason System.String = ""
public static QrPayloadData BezahlCodeContact(QrBezahlAuthorityType authority, String name, String account = "", String bnc = "", String iban = "", String bic = "", String reason = "") #Returns:
QrPayloadDataBuilds a BezahlCode contact payload.
Parameters
- authority CodeGlyphX.Payloads.QrBezahlAuthorityType
- name System.String
- account System.String = ""
- bnc System.String = ""
- iban System.String = ""
- bic System.String = ""
- reason System.String = ""
public static QrPayloadData BezahlCodePeriodicSinglePayment(String name, String account, String bnc, Decimal amount, QrBezahlPeriodicUnit periodicUnit, Int32 periodicUnitRotation, DateTime periodicFirstExecutionDate, DateTime periodicLastExecutionDate, String reason = "", String currency = "EUR", String postingKey = "") #Returns:
QrPayloadDataBuilds a BezahlCode periodic single payment payload (non-SEPA).
Parameters
- name System.String
- account System.String
- bnc System.String
- amount System.Decimal
- periodicUnit CodeGlyphX.Payloads.QrBezahlPeriodicUnit
- periodicUnitRotation System.Int32
- periodicFirstExecutionDate System.DateTime
- periodicLastExecutionDate System.DateTime
- reason System.String = ""
- currency System.String = "EUR"
- postingKey System.String = ""
public static QrPayloadData BezahlCodePeriodicSinglePaymentSepa(String name, String iban, String bic, Decimal amount, QrBezahlPeriodicUnit periodicUnit, Int32 periodicUnitRotation, DateTime periodicFirstExecutionDate, DateTime periodicLastExecutionDate, String reason = "", String currency = "EUR", String sepaReference = "") #Returns:
QrPayloadDataBuilds a BezahlCode periodic single payment payload (SEPA).
Parameters
- name System.String
- iban System.String
- bic System.String
- amount System.Decimal
- periodicUnit CodeGlyphX.Payloads.QrBezahlPeriodicUnit
- periodicUnitRotation System.Int32
- periodicFirstExecutionDate System.DateTime
- periodicLastExecutionDate System.DateTime
- reason System.String = ""
- currency System.String = "EUR"
- sepaReference System.String = ""
public static QrPayloadData BezahlCodeSingleDirectDebit(String name, String account, String bnc, Decimal amount, String creditorId, String mandateId, DateTime dateOfSignature, String reason = "", String currency = "EUR", String postingKey = "", Nullable<DateTime> executionDate = null) #Returns:
QrPayloadDataBuilds a BezahlCode single direct debit payload (non-SEPA).
Parameters
- name System.String
- account System.String
- bnc System.String
- amount System.Decimal
- creditorId System.String
- mandateId System.String
- dateOfSignature System.DateTime
- reason System.String = ""
- currency System.String = "EUR"
- postingKey System.String = ""
- executionDate System.Nullable{System.DateTime} = null
public static QrPayloadData BezahlCodeSingleDirectDebitSepa(String name, String iban, String bic, Decimal amount, String creditorId, String mandateId, DateTime dateOfSignature, String reason = "", String currency = "EUR", String sepaReference = "", Nullable<DateTime> executionDate = null) #Returns:
QrPayloadDataBuilds a BezahlCode single direct debit payload (SEPA).
Parameters
- name System.String
- iban System.String
- bic System.String
- amount System.Decimal
- creditorId System.String
- mandateId System.String
- dateOfSignature System.DateTime
- reason System.String = ""
- currency System.String = "EUR"
- sepaReference System.String = ""
- executionDate System.Nullable{System.DateTime} = null
public static QrPayloadData BezahlCodeSinglePayment(String name, String account, String bnc, Decimal amount, String reason = "", String currency = "EUR", String postingKey = "", Nullable<DateTime> executionDate = null) #Returns:
QrPayloadDataBuilds a BezahlCode single payment payload (non-SEPA).
Parameters
- name System.String
- account System.String
- bnc System.String
- amount System.Decimal
- reason System.String = ""
- currency System.String = "EUR"
- postingKey System.String = ""
- executionDate System.Nullable{System.DateTime} = null
public static QrPayloadData BezahlCodeSinglePaymentSepa(String name, String iban, String bic, Decimal amount, String reason = "", String currency = "EUR", String sepaReference = "", Nullable<DateTime> executionDate = null) #Returns:
QrPayloadDataBuilds a BezahlCode single payment payload (SEPA).
Parameters
- name System.String
- iban System.String
- bic System.String
- amount System.Decimal
- reason System.String = ""
- currency System.String = "EUR"
- sepaReference System.String = ""
- executionDate System.Nullable{System.DateTime} = null
public static QrPayloadData BitcoinLike(QrBitcoinLikeType type, String address, Nullable<Double> amount = null, String label = null, String message = null) #Returns:
QrPayloadDataBuilds a Bitcoin-like URI payload.
Parameters
- type CodeGlyphX.Payloads.QrBitcoinLikeType
- address System.String
- amount System.Nullable{System.Double} = null
- label System.String = null
- message System.String = null
public static QrPayloadData Bookmark(String url, String title) #Returns:
QrPayloadDataBuilds a bookmark payload (MEBKM).
Parameters
- url System.String
- title System.String
public static QrPayloadData CalendarEvent(String subject, String description, String location, DateTime start, DateTime end, Boolean allDayEvent, QrCalendarEncoding encoding = Universal) #Returns:
QrPayloadDataBuilds a calendar event payload.
Parameters
- subject System.String
- description System.String
- location System.String
- start System.DateTime
- end System.DateTime
- allDayEvent System.Boolean
- encoding CodeGlyphX.Payloads.QrCalendarEncoding = Universal
public static QrPayloadData Contact(QrContactOutputType outputType, String firstname, String lastname, String nickname = null, String phone = null, String mobilePhone = null, String workPhone = null, String email = null, Nullable<DateTime> birthday = null, String website = null, String street = null, String houseNumber = null, String city = null, String zipCode = null, String country = null, String note = null, String stateRegion = null, QrContactAddressOrder addressOrder = Default, String org = null, String orgTitle = null, QrContactAddressType addressType = HomePreferred) #Returns:
QrPayloadDataBuilds a contact payload (MeCard or vCard).
Parameters
- outputType CodeGlyphX.Payloads.QrContactOutputType
- firstname System.String
- lastname System.String
- nickname System.String = null
- phone System.String = null
- mobilePhone System.String = null
- workPhone System.String = null
- email System.String = null
- birthday System.Nullable{System.DateTime} = null
- website System.String = null
- street System.String = null
- houseNumber System.String = null
- city System.String = null
- zipCode System.String = null
- country System.String = null
- note System.String = null
- stateRegion System.String = null
- addressOrder CodeGlyphX.Payloads.QrContactAddressOrder = Default
- org System.String = null
- orgTitle System.String = null
- addressType CodeGlyphX.Payloads.QrContactAddressType = HomePreferred
public static QrPayloadData Detect(String input, QrPayloadDetectOptions options = null) #Returns:
QrPayloadDataDetects the most likely payload type from a raw input string.
Parameters
- input System.String
- options CodeGlyphX.Payloads.QrPayloadDetectOptions = null
public static QrPayloadData Email(String address, String subject = null, String message = null, QrMailEncoding encoding = Mailto) #Returns:
QrPayloadDataBuilds an email payload.
Parameters
- address System.String
- subject System.String = null
- message System.String = null
- encoding CodeGlyphX.Payloads.QrMailEncoding = Mailto
public static QrPayloadData Facebook(String profileOrUrl) #Returns:
QrPayloadDataBuilds a Facebook profile payload.
Parameters
- profileOrUrl System.String
public static QrPayloadData FacebookProfile(String handleOrUrl) #Returns:
QrPayloadDataBuilds a Facebook profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData Geo(String latitude, String longitude, QrGeolocationEncoding encoding = Geo) #Returns:
QrPayloadDataBuilds a geolocation payload.
Parameters
- latitude System.String
- longitude System.String
- encoding CodeGlyphX.Payloads.QrGeolocationEncoding = Geo
public static QrPayloadData Girocode(String iban, String bic, String name, Decimal amount, String remittanceInformation = "", QrGirocodeRemittanceType remittanceType = Unstructured, String purposeOfCreditTransfer = "", String messageToGirocodeUser = "", QrGirocodeVersion version = Version1, QrGirocodeEncoding encoding = Iso8859_1) #Returns:
QrPayloadDataBuilds a SEPA Girocode payload.
Parameters
- iban System.String
- bic System.String
- name System.String
- amount System.Decimal
- remittanceInformation System.String = ""
- remittanceType CodeGlyphX.Payloads.QrGirocodeRemittanceType = Unstructured
- purposeOfCreditTransfer System.String = ""
- messageToGirocodeUser System.String = ""
- version CodeGlyphX.Payloads.QrGirocodeVersion = Version1
- encoding CodeGlyphX.Payloads.QrGirocodeEncoding = Iso8859_1
public static QrPayloadData LinkedIn(String handleOrUrl) #Returns:
QrPayloadDataBuilds a LinkedIn profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData LinkedInCompany(String handleOrUrl) #Returns:
QrPayloadDataBuilds a LinkedIn company payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData LinkedInProfile(String handleOrUrl) #Returns:
QrPayloadDataBuilds a LinkedIn profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData Mms(String number, String subject = null, QrMmsEncoding encoding = Mms) #Returns:
QrPayloadDataBuilds an MMS payload.
Parameters
- number System.String
- subject System.String = null
- encoding CodeGlyphX.Payloads.QrMmsEncoding = Mms
public static QrPayloadData Monero(String address, Nullable<Single> amount = null, String paymentId = null, String recipientName = null, String description = null) #Returns:
QrPayloadDataBuilds a Monero URI payload.
Parameters
- address System.String
- amount System.Nullable{System.Single} = null
- paymentId System.String = null
- recipientName System.String = null
- description System.String = null
public static QrPayloadData OneTimePassword(OtpAuthType type, String secretBase32, String label = null, String issuer = null, OtpAlgorithm algorithm = Sha1, Int32 digits = 6, Nullable<Int32> period = 30, Nullable<Int32> counter = null) #Returns:
QrPayloadDataBuilds an otpauth URI payload for HOTP/TOTP.
Parameters
- type CodeGlyphX.OtpAuthType
- secretBase32 System.String
- label System.String = null
- issuer System.String = null
- algorithm CodeGlyphX.OtpAlgorithm = Sha1
- digits System.Int32 = 6
- period System.Nullable{System.Int32} = 30
- counter System.Nullable{System.Int32} = null
public static QrPayloadData PayPalMe(String handleOrUrl, Nullable<Decimal> amount = null, String currency = null, Boolean useHttps = true) #Returns:
QrPayloadDataBuilds a PayPal.Me payment payload.
Parameters
- handleOrUrl System.String
- amount System.Nullable{System.Decimal} = null
- currency System.String = null
- useHttps System.Boolean = true
public static QrPayloadData Phone(String number) #Returns:
QrPayloadDataBuilds a phone payload (tel:).
Parameters
- number System.String
RussiaPaymentOrder 2 overloads
public static QrPayloadData RussiaPaymentOrder(String name, String personalAcc, String bankName, String bic, String correspAcc, String payeeInn, String kpp, Decimal sum, String purpose) #Returns:
QrPayloadDataBuilds a Russia payment order payload (ST00012).
Parameters
- name System.String
- personalAcc System.String
- bankName System.String
- bic System.String
- correspAcc System.String
- payeeInn System.String
- kpp System.String
- sum System.Decimal
- purpose System.String
public static QrPayloadData RussiaPaymentOrder(RussiaPaymentOrderPayload payload) #Returns:
QrPayloadDataBuilds a Russia payment order payload.
Parameters
- payload CodeGlyphX.Payloads.RussiaPaymentOrderPayload
ShadowSocks 2 overloads
public static QrPayloadData ShadowSocks(String hostname, Int32 port, String password, QrShadowSocksMethod method, String tag = null) #Returns:
QrPayloadDataBuilds a Shadowsocks URI payload.
Parameters
- hostname System.String
- port System.Int32
- password System.String
- method CodeGlyphX.Payloads.QrShadowSocksMethod
- tag System.String = null
public static QrPayloadData ShadowSocks(String hostname, Int32 port, String password, QrShadowSocksMethod method, Dictionary<String, String> parameters, String tag = null) #Returns:
QrPayloadDataBuilds a Shadowsocks URI payload with parameters.
Parameters
- hostname System.String
- port System.Int32
- password System.String
- method CodeGlyphX.Payloads.QrShadowSocksMethod
- parameters System.Collections.Generic.Dictionary{System.String,System.String}
- tag System.String = null
public static QrPayloadData SkypeCall(String username) #Returns:
QrPayloadDataBuilds a Skype call payload.
Parameters
- username System.String
public static QrPayloadData SlovenianUpn(SlovenianUpnQrPayload payload) #Returns:
QrPayloadDataBuilds a Slovenian UPN QR payload.
Parameters
- payload CodeGlyphX.Payloads.SlovenianUpnQrPayload
public static QrPayloadData Sms(String number, String message = null, QrSmsEncoding encoding = Sms) #Returns:
QrPayloadDataBuilds an SMS payload.
Parameters
- number System.String
- message System.String = null
- encoding CodeGlyphX.Payloads.QrSmsEncoding = Sms
public static QrPayloadData SwissQrCode(SwissQrCodePayload payload) #Returns:
QrPayloadDataBuilds a Swiss QR Code payload.
Parameters
- payload CodeGlyphX.Payloads.SwissQrCodePayload
public static QrPayloadData Text(String text) #Returns:
QrPayloadDataBuilds a plain text payload.
Parameters
- text System.String
public static QrPayloadData TikTok(String handleOrUrl) #Returns:
QrPayloadDataBuilds a TikTok profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData TikTokProfile(String handleOrUrl) #Returns:
QrPayloadDataBuilds a TikTok profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData Twitter(String handleOrUrl) #Returns:
QrPayloadDataBuilds a Twitter/X profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData TwitterProfile(String handleOrUrl) #Returns:
QrPayloadDataBuilds a Twitter profile payload.
Parameters
- handleOrUrl System.String
public static QrPayloadData Upi(String vpa, String name = null, String merchantCode = null, String transactionRef = null, String transactionNote = null, Nullable<Decimal> amount = null, String currency = "INR") #Returns:
QrPayloadDataBuilds a UPI payment payload.
Parameters
- vpa System.String
- name System.String = null
- merchantCode System.String = null
- transactionRef System.String = null
- transactionNote System.String = null
- amount System.Nullable{System.Decimal} = null
- currency System.String = "INR"
public static QrPayloadData Url(String url) #Returns:
QrPayloadDataBuilds a URL payload.
Parameters
- url System.String
public static QrPayloadData WhatsAppMessage(String message, String number = null) #Returns:
QrPayloadDataBuilds a WhatsApp message payload.
Parameters
- message System.String
- number System.String = null
public static QrPayloadData Wifi(String ssid, String password, String authType = "WPA", Boolean hidden = false, Boolean escapeHexStrings = true) #Returns:
QrPayloadDataBuilds a Wi-Fi payload.
Parameters
- ssid System.String
- password System.String
- authType System.String = "WPA"
- hidden System.Boolean = false
- escapeHexStrings System.Boolean = true
public static QrPayloadData XProfile(String handleOrUrl) #Returns:
QrPayloadDataBuilds an X profile payload.
Parameters
- handleOrUrl System.String