UUID Plugin API

new

Create a new universally unique identifier.

UUID.new()

Arguments

This method takes no arguments.

Returns

A new UUID as a String.

Example

local uuid = UUID.new()

print(uuid) --> 5D91AFDF-17D1-5942-9216-E593BD9EC80A

Notes

• If you want to generate multiple UUIDs in one pass, do not use a for loop with this method. See the batch method instead.

save

Create and save a persistent universally unique identifier to the device. The UUID is saved to the Documents directory.

By default the filename is "_uuid", but can be changed by providing a name to the filename argument.

If a saved UUID already exists, you must pass the overwrite flag to save a new UUID.

UUID.save([overwrite,][ filename])

Arguments

Returns

On success, a new UUID as a String, or nil and an error.

Examples

-- Create and save a UUID
local uuid = UUID.save()

-- Overwrite a saved UUID
local uuid = UUID.save(true)

-- Use a alternative name
local uuid = UUID.save("_userid")

-- Overwrite with the alternative name
local uuid = UUID.save(true, "_userid")

-- With error checking
local uuid, err = UUID.save([args])

if not uuid then
  print(err)
end

Notes

• If you save a UUID with an alternative name and wish to overwrite it, you must pass the overwrite flag, as well as the alternative name it was saved with.

• You can generate and save multiple UUIDs by using the filename argument with different values. Load them by passing the same name to the load method.

load

Load a saved universally unique identifier from the device. The UUID is loaded from the Documents directory.

By default the filename loaded is "_uuid", but can be changed by providing a name to the filename argument.

To guarantee a UUID will be loaded, you can pass the create flag to have a newly saved UUID generated. If the file already exists, this flag is ignored.

UUID.load([create,][ filename])

Arguments

Returns

On success, the saved UUID as a String, or nil and an error.

Example

-- Load a saved UUID
local uuid = UUID.load()

-- Create a new UUID file if none exists
local uuid = UUID.load(true)

-- Load using an alternative name
local uuid = UUID.load("_userid")

-- Create a new UUID file if none exists
-- Use an alternative name for the file.
local uuid = UUID.load(true, "_userid")

-- With error checking
local uuid, err = UUID.load([args])

if not uuid then
  print(err)
end

Notes

• If the UUID you want to load was saved with an alternative name, you must pass that name to the filename argument when calling the load method.

delete

Delete a saved universally unique identifier from the device. The UUID is removed from the Documents directory.

UUID.delete([filename])

Arguments

Returns

On success, the Boolean true, or nil and an error.

Example

-- Delete a saved UUID
local uuid = UUID.delete()

-- Delete with the alternative name
local uuid = UUID.delete("_userid")

-- With error checking
local ok, err = UUID.delete([args])

if not ok then
  print(err)
end

Notes

• If the UUID you want to delete was saved with an alternative name, you must pass that name to the filename argument when calling the delete method.

batch

Create multiple universally unique identifiers in one pass.

While UUIDs are generated with millisecond precision, if trying to produce multiple UUIDs using a for loop you may generate a duplicate UUID. Use this method instead to guarantee a batch of unique ids.

UUID.batch(count)

Arguments

Returns

A Table array of UUIDs.

Example

--Generate 10 UUIDs
local uuids = UUID.batch(10)

for i=1, #uuids do
  print(uuids[i])
end

Notes

• Batches are not saved to any file.