Skip to content

Reference

phil/qr-code

Every public type of the package, with its role.

TypeRole
QrCodeA symbol: encode(), fromSegments(), size(), isDark(), rows(), and how it was built.
SegmentA run of the data in one mode, or an ECI header.
ModeThe numeric, alphanumeric, byte and kanji modes, and the ECI header.
ErrorCorrectionThe four levels of error correction, L, M, Q and H.
ZoneThe square a code keeps at its centre for a logo.
LogoA PNG, JPEG, WebP or SVG image to draw in the zone.
SvgWriterDraws a QrCode as an SVG image.
PngWriterDraws a QrCode as a PNG image.
Contract\ContentWhat a typed content gives: its payload and its label.
Content\Url, Email, Phone, Sms, GeoAddresses to open, write to, call, text, or a place.
Content\Wifi, WifiSecurityA network to join, and its protection.
Content\MeCard, VCard, VCardVersion, PostalAddressA contact, in the compact MeCard form or as a vCard.
Content\EventAn event to add to a calendar.
Exception\QrCodeExceptionImplemented by every exception of the package.
Exception\DataTooLongThe data does not fit in version 40 at the level asked.
Exception\InvalidOptionA version, mask, zone, segment, quiet zone, colour, scale, size or logo out of its range.
Exception\InvalidContentA field of a typed content that cannot be written.